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)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Campos
packageName

string

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

string

Imutável. ID exclusivo do produto. Exclusivo no app principal. Os IDs dos produtos precisam ser compostos por letras minúsculas (a-z), números (0-9), sublinhados (_) e pontos (.). Ele precisa começar com uma letra minúscula ou um número e ter entre 1 e 40 caracteres.
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 for aplicável.
listings[]

object (SubscriptionListing)

Obrigatório. Lista de listagens localizadas para esta assinatura. Precisa conter pelo menos uma entrada para o idioma padrão do app principal.
archived
(deprecated)

boolean

Apenas saída. Obsoleto: não é possível arquivar assinaturas.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Detalhes sobre tributos e compliance legal.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Opcional. São os países em que a compra da assinatura está restrita às formas de pagamento registradas no mesmo país. Se estiver vazio, nenhuma restrição de local de pagamento será imposta.

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)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
Campos
basePlanId

string

Obrigatório. Imutável. O identificador exclusivo deste plano básico. Precisa ser exclusivo dentro da assinatura e estar em conformidade com o RFC-1034. Ou seja, esse ID só pode ter 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 está ativo. É possível ativar ou excluir planos básicos inativos e de rascunho. Planos básicos ativos podem ser desativados. Planos básicos inativos podem ser cancelados. Não é possível alterar este campo com a atualização do 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 de faturamento. As ofertas de assinatura do plano básico também vão receber as tags de oferta na Biblioteca de faturamento.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informações sobre preços de 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 deste plano básico. Exatamente um deve ser definido. base_plan_type pode ser apenas de um dos tipos a seguir:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Defina a renovação automática do plano básico em um intervalo regular.
prepaidBasePlanType

object (PrepaidBasePlanType)

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

object (InstallmentsBasePlanType)

Definido para planos básicos de parcelas em que um usuário está comprometido com um número especificado de pagamentos.

Estado

Estado atual de um plano básico.

Enums
STATE_UNSPECIFIED Estado não especificado.
DRAFT No momento, o plano básico está em rascunho e não foi ativado. Ela pode ser excluída com segurança neste momento.
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.

AutoRenewingBasePlanType

Representa um plano básico que é renovado automaticamente no fim 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 ver 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 (zero 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.
accountHoldDuration

string

Opcional. Período de suspensão de conta da assinatura, especificado no formato ISO 8601. Os valores aceitáveis precisam 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)

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á REsubscribe_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 outro plano básico para este. Se não for especificado, o padrão será CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Indica se o plano básico de renovação é 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 com renovação pode ser marcado como compatível com versões anteriores para uma determinada assinatura.
legacyCompatibleSubscriptionOfferId

string

ID da oferta de assinatura que é compatível com versões anteriores.

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

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

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

ResubscribeState

Estado de reativaçã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 da assinatura está inativa.

SubscriptionProrationMode

O modo de cálculo proporcional usado para renovar 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 ao final 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 integralmente. Qualquer período restante da assinatura atual será usado para prolongar a duração do novo plano de faturamento.

PrepaidBasePlanType

Representa um plano básico que não é renovado automaticamente ao final dele e 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 ver 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. O padrão será TIME_EXTENSION_ACTIVE se não for especificado.

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

InstallmentsBasePlanType

Representa um plano básico de parcelas em que um usuário se compromete com um número especificado de pagamentos.

Representação JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Campos
billingPeriodDuration

string

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

integer

Obrigatório. O número de pagamentos com que o usuário está comprometido.
renewalType

enum (RenewalType)

Obrigatório. Tipo de renovação do plano básico em parcelas. Determina o comportamento ao final do compromisso inicial.
gracePeriodDuration

string

Período de carência da assinatura, especificado no formato ISO 8601. Os valores aceitáveis são P0D (zero 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.
accountHoldDuration

string

Opcional. Período de suspensão de conta da assinatura, especificado exclusivamente em dias e no formato ISO 8601. Os valores aceitáveis são P0D (zero dias) a P30D (30 dias). Se não for especificado, o valor padrão será P30D (30 dias).
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á REsubscribe_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 outro plano básico para este. Se não for especificado, o padrão será CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Tipo de renovação do plano básico em parcelas. Determina o comportamento ao final do compromisso inicial.

Enums
RENEWAL_TYPE_UNSPECIFIED Estado não especificado.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT É renovada periodicamente pelo período de faturamento sem compromisso.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT É renovada com o compromisso com a mesma duração do primeiro.

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 esta 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 "false". 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 preços de todos os novos locais em que o Google Play for 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 possa ser lançado.
eurPrice

object (Money)

Obrigatório. Preço em EUR para usar em novos locais em que o Google Play possa ser lançado.
newSubscriberAvailability

boolean

Se o plano básico está disponível para novos assinantes em qualquer novo local em que o Google Play possa ser lançado. Se não for especificado, o padrão será "false".

SubscriptionListing

Os metadados visíveis ao consumidor de uma assinatura.

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

string

Obrigatório. O idioma da página de detalhes, 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 de 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 de no máximo quatro benefícios.
description

string

É a descrição da assinatura no idioma desta página de detalhes. Tamanho máximo: 80 caracteres. Texto simples.

RestrictedPaymentCountries

Países onde a compra deste produto está restrita às formas de pagamento registradas no mesmo país. Se estiver vazio, nenhuma restrição de local de pagamento será imposta.

Representação JSON 
{
  "regionCodes": [
    string
  ]
}
Campos
regionCodes[]

string

Obrigatório. Códigos de região aos quais impor restrições de pagamento, conforme definido pelo ISO 3166-2, por exemplo, "US".

Métodos

archive
(deprecated)

 Obsoleto: não é possível arquivar 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.