REST Resource: monetization.subscriptions

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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. Único no app pai. Os IDs de produto 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 (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. apks.list de listagens localizadas para esta assinatura. É preciso 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 nenhum assinante, não podem ser atualizadas e não são retornadas em solicitações de lista, a menos que a sinalização de arquivamento arquivado 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 desse plano básico. Precisa ser exclusivo na 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. Estado do plano básico, ou seja, se ele está ativo. Os planos básicos e inativos 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 em vez disso.

regionalConfigs[]

object (RegionalBasePlanConfig)

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

offerTags[]

object (OfferTag)

apks.list de até 20 tags personalizadas especificadas para esse plano básico e retornadas ao app por meio da Biblioteca Faturamento. As ofertas de assinatura desse plano básico também receberão essas tags de oferta na Biblioteca 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 ficará automaticamente disponível para novos locais que o Google Play lançar no futuro.

Campo de união base_plan_type. É o tipo de 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 ao fim do período de faturamento.

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 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 dos 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 (nenhum dia), 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 poderão assinar esse plano básico novamente nas plataformas do Google Play. O padrão será RESUBSCRIBE_STATE_ACTIVE se não for especificado.

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 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 da Biblioteca Google Play Faturamento "querySkuDetailsAsync()".

Somente um plano básico renovado pode ser marcado como compatível com versões legadas para uma determinada assinatura.

legacyCompatibleSubscriptionOfferId

string

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

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

Somente uma oferta de assinatura pode ser marcada como compatível com planos legados para renovação de um determinado plano.

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

Assinar novamente

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

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

Modo de registro da 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 de maneira imediata e completa. O período restante da assinatura atual será usado para estender a duração do novo plano de faturamento.

TipoPré-pagodoBasePlan

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

timeExtension

enum (TimeExtension)

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

Extensão de tempo

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

RegionalBasePlanPlanConfig

Configuração de 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 regional ao qual esta configuração se aplica, conforme definido pela ISO 3166-2, por exemplo, "quot;US"".

newSubscriberAvailability

boolean

Indica se o plano básico na região especificada está disponível para novos assinantes. As assinaturas existentes não serão canceladas se esse valor for definido como falso. Se não for especificado, o padrão será falso.

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.

OutrasRegiõesBaseBasePlanConfig

São informações de preço 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. O preço é usado em USD para qualquer novo local em que o Google Play possa ser lançado.

eurPrice

object (Money)

Obrigatório. Preço em EUR para uso em novos locais em que o Google Play poderá ser lançado.

newSubscriberAvailability

boolean

Indica se o plano básico estará disponível para novos assinantes em novos locais em que o Google Play poderá ser lançado. Se não for especificado, o padrão será falso.

Assinatura de assinaturas

Os metadados visíveis para o consumidor de uma assinatura.

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

string

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

title

string

Obrigatório. O título desta assinatura no idioma desta ficha. Texto simples.

benefits[]

string

Uma lista de benefícios exibidos ao usuário em plataformas como a Play Store e nos fluxos de restauração no idioma dessa ficha. Texto simples. Lista ordenada de no máximo quatro benefícios.

description

string

É a descrição da assinatura no idioma dessa ficha. Tamanho máximo: 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.