REST Resource: purchases.subscriptions

Recurso: SubscriptionPurchase

O recurso SubscriptionPurchase indica o status da compra de 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)

Horário em que a assinatura foi concedida, em milissegundos, desde a época.
expiryTimeMillis

string (int64 format)

Horário em que a assinatura expira, em milissegundos, desde o período.
autoResumeTimeMillis

string (int64 format)

Momento em que a assinatura será retomada automaticamente, em milissegundos, a partir da época. Presente apenas se o usuário tiver solicitado a pausar a assinatura.
autoRenewing

boolean

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

string

Código de moeda ISO 4217 para o preço da assinatura. Por exemplo, se o preço for especificado em libras esterlinas, priceCurrencyCode é "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 tributos. O preço é expresso em microunidades, em que um milhão de microunidades representa uma unidade da moeda. Por exemplo, se o preço da assinatura for € 1,99, priceAmountMicros será 1990000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

Informações sobre o preço inicial da assinatura. Isso só está presente quando a assinatura foi comprada por um preço inicial.

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

string

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 disponível para assinaturas canceladas e expiradas.
cancelReason

integer

O motivo pelo qual uma assinatura foi cancelada ou não está sendo renovada automaticamente. 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)

É o horário 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 foi cancelada porque o pagamento foi recusado, este será o ID do pedido de pagamento recusado.
linkedPurchaseToken

string

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

Por exemplo, suponha que um usuário originalmente se inscreveu e você recebesse o token de compra X. Em seguida, o usuário cancela e passa pelo fluxo de nova assinatura (antes que a assinatura expire) e você recebe o token de compra Y. Por fim, o usuário faz upgrade da assinatura e você recebe 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. Esse campo só será definido se a compra não tiver sido feita usando o fluxo padrão de faturamento no app. Os valores possíveis são: 0. Teste (por exemplo, comprado de uma conta de teste de licença) 1. Promoção (ou seja, comprada usando um código promocional)
priceChange

object (SubscriptionPriceChange)

As informações mais recentes sobre a mudança de preço disponíveis. Isso estará presente apenas quando houver uma mudança de preço para a assinatura ainda a ser aplicada.

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

string

O nome do perfil do usuário quando a assinatura foi comprada. Presente apenas em compras feitas com o "Assine com o Google".
emailAddress

string

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

string

O nome do usuário quando a assinatura foi comprada. Presente apenas em compras feitas com o "Assine com o Google".
familyName

string

O sobrenome do usuário quando a assinatura foi comprada. Presente apenas em 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 em 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 não confirmado 1. Reconhecido
externalAccountId

string

Identificador de conta de usuário no serviço de terceiros. Presente apenas se a vinculação da conta tiver acontecido como parte do fluxo de compra da assinatura.
promotionType

integer

O tipo de promoção aplicado a esta compra. Esse campo só é definido se uma promoção é 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. Esse 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 exclusivamente associada à conta do usuário no app. Presente com as seguintes compras: * Se a vinculação de contas tiver ocorrido como parte do fluxo de compra de assinatura. * Ele 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 é exclusivamente associada ao perfil do usuário no seu app. Presente somente se especificado usando https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid quando a compra foi feita.

IntroductoryPriceInfo

Contém as informações sobre o 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 inicial da assinatura. Por exemplo, se o preço for especificado em libras esterlinas, priceCurrencyCode é "GBP".
introductoryPriceAmountMicros

string (int64 format)

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

string

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

integer

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

SubscriptionCancelSurveyResult

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

O motivo do cancelamento que o usuário escolheu na pesquisa. Os valores possíveis são: 0. Outro 1. Não uso o serviço com frequência 2. Problemas técnicos 3. Motivos relacionados a custos 4. Descobri um app melhor
userInputCancelReason

string

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

SubscriptionPriceChange

Contém informações sobre a mudança de preço de uma assinatura que podem ser usadas para controlar o percurso do usuário até a mudança no app. Isso pode ser na forma de pedir a confirmação do usuário ou personalizar a experiência para uma conversão bem-sucedida.

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

object (Price)

O novo preço com que a assinatura vai ser renovada 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: indica uma mudança de preço pendente que aguarda a aprovação do usuário. Nesse estado, você tem a opção de buscar a confirmação do usuário usando a API no aplicativo. 1. Aceita: indique uma mudança de preço aceita com que a assinatura vai 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 na próxima renovação da assinatura.

Métodos

acknowledge

 Confirma a compra de uma assinatura.

cancel

 Cancela a compra da assinatura de um usuário.

defer

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

get

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

refund

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

revoke

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