REST Resource: purchases.subscriptions

Recurso: SubscriptionPurchase

Um recurso SubscriptionPurchase indica o status da compra de uma assinatura de um usuário.

Representação JSON 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Campos
kind

string

Esse tipo representa um objeto SubscriptionPurchase no serviço androidpublisher.
startTimeMillis

string (int64 format)

Tempo em que a assinatura foi concedida, em milissegundos desde a época.
expiryTimeMillis

string (int64 format)

Tempo em que a assinatura expira, em milissegundos desde a Época.
autoResumeTimeMillis

string (int64 format)

Tempo em que a assinatura será retomada automaticamente, em milissegundos desde o período. Presente apenas se o usuário tiver solicitado a pausa da assinatura.
autoRenewing

boolean

Indica se a assinatura será renovada automaticamente quando atingir o prazo de validade atual.
priceCurrencyCode

string

Código de moeda ISO 4217 para o preço de assinatura. Por exemplo, se o preço for especificado em libras esterlinas, o priceCurrencyCode será "GBP".
priceAmountMicros

string (int64 format)

Preço da assinatura: para países sem tributos, o preço não inclui tributos. Para países com tributos, o preço inclui impostos. O preço é expresso em microunidades, em que 1.000.000 de microunidades representa uma unidade da moeda. Por exemplo, se o preço da assinatura for € 1,99, o priceAmountMicros será 1990000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

Informações iniciais de preços da assinatura. Só está presente quando a assinatura foi comprada com um preço inicial.

Esse campo não indica que a assinatura está no período de preço inicial.
countryCode

string

É o código do país/região de faturamento ISO 3166-1 alfa-2 do usuário no momento em que a assinatura foi concedida.
developerPayload

string

Uma string especificada pelo desenvolvedor que contém informações complementares sobre um pedido.
paymentState

integer

É o estado de pagamento da assinatura. Os valores possíveis são: 0. Pagamento pendente 1. Pagamento recebido 2. Teste sem custo financeiro 3. Upgrade/downgrade adiado pendente

Não presente para assinaturas canceladas que expiraram.
cancelReason

integer

É o motivo de uma assinatura ter sido cancelada ou não ter renovação automática. Os valores possíveis são: 0. O usuário cancelou a assinatura 1. A assinatura foi cancelada pelo sistema, por exemplo, devido a um problema de faturamento 2. A assinatura foi substituída por uma nova assinatura 3. A assinatura foi cancelada pelo desenvolvedor
userCancellationTimeMillis

string (int64 format)

A hora em que a assinatura foi cancelada pelo usuário, em milissegundos desde o período. Presente apenas se cancelReason for 0.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

Informações fornecidas pelo usuário quando ele conclui o fluxo de cancelamento da assinatura (pesquisa sobre o motivo do cancelamento).
orderId

string

É o código do pedido recorrente mais recente associado à compra da assinatura. Se a assinatura tiver sido cancelada porque o pagamento foi recusado, este será o código do pedido recusado.
linkedPurchaseToken

string

O token de compra da origem, se a assinatura for uma das seguintes: 0. Nova inscrição cancelada de 1 assinatura cancelada. Fazer upgrade/downgrade de uma assinatura anterior

Por exemplo, suponha que um usuário se inscreva originalmente e você receba o token de compra X, depois ele cancele e passe pelo fluxo de reinscrição (antes que a assinatura expire), e você receba o token de compra Y e, finalmente, o usuário faça upgrade da assinatura, e você receba o token de compra Z. Se você chamar essa API com o token de compra Z, esse campo será definido como Y. Se você chamar essa API com o token de compra Y, esse campo será definido como X. Se você chamar essa API com o token de compra X, esse campo não será definido.
purchaseType

integer

É o tipo de compra da assinatura. Este campo só será definido se a compra não tiver sido feita usando o fluxo de faturamento padrão no app. Os valores possíveis são: 0. Teste (ou seja, comprado de uma conta de teste de licença) 1. Promoção (ou seja, compra com o uso de um código promocional)
priceChange

object (SubscriptionPriceChange)

As informações mais recentes sobre a mudança de preço estão disponíveis. Isso está presente apenas quando há uma mudança de preço futura para a assinatura que ainda não foi aplicada.

Depois que a assinatura for renovada com o novo preço ou ela for cancelada, nenhuma informação sobre mudanças de preço será retornada.
profileName

string

É o nome do perfil do usuário quando a assinatura foi comprada. Presente apenas para compras feitas com o 'Assine com o Google'
emailAddress

string

Mostra o endereço de e-mail do usuário quando a assinatura foi comprada. Presente apenas para compras feitas com o 'Assine com o Google'
givenName

string

É o nome fornecido do usuário quando a assinatura foi comprada. Presente apenas para compras feitas com o 'Assine com o Google'
familyName

string

O nome da família do usuário quando a assinatura foi comprada. Presente apenas para compras feitas com o 'Assine com o Google'
profileId

string

É o ID do perfil do Google do usuário quando a assinatura foi comprada. Presente apenas para compras feitas com o 'Assine com o Google'
acknowledgementState

integer

O estado de confirmação do produto por assinatura. Os valores possíveis são: 0. Ainda a ser confirmado 1. Recebida
externalAccountId

string

É o identificador da conta de usuário no serviço de terceiros. Só estará presente se a vinculação da conta tiver ocorrido como parte do fluxo de compra da assinatura.
promotionType

integer

O tipo de promoção aplicada nesta compra. Este campo só será definido se uma promoção for aplicada quando a assinatura foi comprada. Os valores possíveis são: 0. Código único 1: Código curto
promotionCode

string

O código promocional aplicado a esta compra. Este campo só será definido se uma promoção de código curto for aplicada quando a assinatura for comprada.
obfuscatedExternalAccountId

string

Uma versão ofuscada do ID que está associada exclusivamente à conta do usuário no seu aplicativo. Presente com as seguintes compras: * Se a vinculação de contas aconteceu como parte do fluxo de compra de assinatura. * Foi especificado usando https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid quando a compra foi feita.
obfuscatedExternalProfileId

string

Uma versão ofuscada do ID que está associada exclusivamente ao perfil do usuário no seu aplicativo. Presente apenas se especificado usando https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid quando a compra é feita.

Informações de preço inicial

Contém as informações de preço inicial de uma assinatura.

Representação JSON 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
Campos
introductoryPriceCurrencyCode

string

Código de moeda ISO 4217 para o preço de assinatura inicial. Por exemplo, se o preço for especificado em libras esterlinas, o priceCurrencyCode será "GBP".
introductoryPriceAmountMicros

string (int64 format)

Preço inicial da assinatura, sem tributos. A moeda é igual a priceCurrencyCode. O preço é expresso em microunidades, em que 1.000.000 de microunidades representa uma unidade da moeda. Por exemplo, se o preço da assinatura for € 1,99, o priceAmountMicros será 1990000.
introductoryPricePeriod

string

Período de preço inicial especificado no formato ISO 8601. Os valores comuns são (mas não estão limitados a) "P1W" (uma semana), "P1M" (um mês), "P3M" (três meses), "P6M" (seis meses) e "P1Y" (um ano).
introductoryPriceCycles

integer

O número de períodos de faturamento para oferecer preços iniciais.

AssinaturaCancelarPesquisaResultado

Informações fornecidas pelo usuário quando ele conclui o fluxo de cancelamento da assinatura (pesquisa sobre o motivo do cancelamento).

Representação JSON 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
Campos
cancelSurveyReason

integer

Motivo do cancelamento que o usuário escolheu na pesquisa. Os valores possíveis são: 0. Outro 1. Eu não uso esse serviço o suficiente. 2. Problemas técnicos 3. Motivos relacionados ao custo 4. Descobri um app melhor
userInputCancelReason

string

O motivo personalizado do cancelamento da entrada do usuário. Presente apenas quando cancelReason é 0.

Alteração de preço da assinatura

Contém as informações de mudança de preço para uma assinatura que podem ser usadas para controlar a jornada do usuário na mudança de preço no app. Isso pode ser feito na forma de busca da confirmação do usuário ou da personalização da experiência para uma conversão bem-sucedida.

Representação JSON 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
Campos
newPrice

object (Price)

O novo preço de renovação da assinatura se a mudança de preço for aceita pelo usuário.
state

integer

O estado atual da mudança de preço. Os valores possíveis são: 0. Pendente: estado de uma alteração de preço pendente aguardando o consentimento do usuário. Nesse caso, você pode buscar a confirmação do usuário usando a API no app. 1. Aceita: estado de uma mudança de preço aceita com que a assinatura será renovada, a menos que seja cancelada. A mudança de preço entrará em vigor em uma data futura quando a assinatura for renovada. A mudança pode não ocorrer quando a assinatura for renovada.

Métodos

acknowledge

 Confirma a compra de uma assinatura.

cancel

 Cancela a compra da assinatura de um usuário.

defer

 Adia a compra da assinatura de um usuário até um prazo de validade especificado especificado.

get

 Verifica se a compra de uma assinatura de um usuário é válida e retorna o prazo de validade.

refund

 Reembolsa a compra de uma assinatura de um usuário, mas a assinatura permanece válida até o prazo de validade e ela continuará recorrente.

revoke

 Reembolsa e revoga imediatamente a compra de uma assinatura do usuário.