- Recurso: SubscriptionPurchase
- IntroductoryPriceInfo
- SubscriptionCancelSurveyResult
- SubscriptionPriceChange
- Métodos
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 ( |
Campos | |
---|---|
kind |
Esse tipo representa um objeto SubscriptionPurchase no serviço androidpublisher. |
startTimeMillis |
Hora em que a assinatura foi concedida, em milissegundos, desde a época. |
expiryTimeMillis |
Horário em que a assinatura vencerá, em milissegundos, desde a época. |
autoResumeTimeMillis |
Horário em que a assinatura será retomada automaticamente, em milissegundos, desde a época. Presente apenas se o usuário solicitar a pausa da assinatura. |
autoRenewing |
Indica se a assinatura será renovada automaticamente quando atingir o prazo de validade atual. |
priceCurrencyCode |
Código de moeda ISO 4217 para o preço da assinatura. Por exemplo, se o preço for especificado em libras esterlinas, o priceCurrencyCode é "GBP". |
priceAmountMicros |
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 é de € 1,99, priceAmountMicros é 1990000. |
introductoryPriceInfo |
Informações sobre o preço inicial da assinatura. Esta opção só está presente quando a assinatura é comprada com um preço inicial. Esse campo não indica que a assinatura está no período de preço inicial. |
countryCode |
Código ISO 3166-1 alfa-2 do país/região de faturamento do usuário no momento em que a assinatura foi concedida. |
developerPayload |
Uma string especificada pelo desenvolvedor que contém informações complementares sobre um pedido. |
paymentState |
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 e expiradas. |
cancelReason |
É o motivo do cancelamento ou da renovação automática de uma assinatura. 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. 3. A assinatura foi cancelada pelo desenvolvedor |
userCancellationTimeMillis |
A hora em que a assinatura foi cancelada pelo usuário, em milissegundos, desde o período. Presente apenas se cancelReason for 0. |
cancelSurveyResult |
Informações fornecidas pelo usuário quando ele conclui o fluxo de cancelamento da assinatura (pesquisa de motivo do cancelamento). |
orderId |
O ID 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 |
O token da compra original, se a assinatura for uma das seguintes: 0. Nova assinatura de uma assinatura cancelada, mas não expirada 1. Fazer upgrade/downgrade de uma assinatura anterior Por exemplo, suponha que um usuário se inscreva e você receba o token de compra X. Em seguida, ele cancela e passa pelo fluxo de nova assinatura (antes do fim da assinatura), 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 esta API com o token de compra X, este campo não será definido. |
purchaseType |
Tipo de compra da assinatura. Este campo só será definido se a compra não tiver sido feita usando o fluxo padrão de faturamento em apps. Os valores possíveis são: 0. Teste (ou seja, comprado de uma conta de teste de licença) 1. Promoção (ou seja, comprada usando um código promocional) |
priceChange |
As informações mais recentes sobre a mudança de preço disponíveis. Esta opção só aparece quando há uma mudança de preço futura para a assinatura que ainda não foi aplicada. Quando a assinatura for renovada com o novo preço ou cancelada, nenhuma informação de mudança de preço será retornada. |
profileName |
Nome do perfil do usuário quando a assinatura foi comprada. Presente apenas para compras feitas com o "Assine com o Google". |
emailAddress |
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 |
É o nome do usuário quando a assinatura foi comprada. Presente apenas para compras feitas com o "Assine com o Google". |
familyName |
Sobrenome do usuário quando a assinatura foi comprada. Presente apenas para compras feitas com o "Assine com o Google". |
profileId |
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 |
O estado de confirmação do produto por assinatura. Os valores possíveis são: 0. A confirmar 1. Confirmação |
externalAccountId |
Identificador de conta de usuário no serviço de terceiros. Presente apenas se a vinculação da conta tiver ocorrido como parte do fluxo de compra da assinatura. |
promotionType |
Tipo de promoção aplicada a esta compra. Este campo só vai ser definido se uma promoção for aplicada quando a assinatura foi comprada. Os valores possíveis são: 0. Código de uso único 1. Código curto |
promotionCode |
O código promocional aplicado nesta compra. Esse campo só será definido se uma promoção de código curto for aplicada quando a assinatura foi comprada. |
obfuscatedExternalAccountId |
Uma versão ofuscada do código que é exclusivamente associada à conta do usuário no seu app. Presente para as seguintes compras: * Se a vinculação da conta aconteceu como parte do fluxo de compra de assinaturas. * Ele foi especificado usando https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid quando a compra foi feita. |
obfuscatedExternalProfileId |
É uma versão ofuscada do código associada exclusivamente ao perfil do usuário no app. Presente apenas se especificado usando https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid no momento da compra. |
IntroductoryPriceInfo
Contém as informações do preço inicial de uma assinatura.
Representação JSON |
---|
{ "introductoryPriceCurrencyCode": string, "introductoryPriceAmountMicros": string, "introductoryPricePeriod": string, "introductoryPriceCycles": integer } |
Campos | |
---|---|
introductoryPriceCurrencyCode |
Código de moeda ISO 4217 para o preço inicial da assinatura. Por exemplo, se o preço for especificado em libras esterlinas, o priceCurrencyCode é "GBP". |
introductoryPriceAmountMicros |
Preço inicial da assinatura, sem incluir tributos. A moeda é igual a 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 é de € 1,99, priceAmountMicros é 1990000. |
introductoryPricePeriod |
Período de preço inicial, especificado no formato ISO 8601. Os valores comuns são (mas não se limitam a) "P1W" (uma semana), "P1M" (um mês), "P3M" (três meses), "P6M" (seis meses) e "P1Y" (um ano). |
introductoryPriceCycles |
O número do período de faturamento em que será oferecido o preço inicial. |
SubscriptionCancelSurveyResult
Informações fornecidas pelo usuário quando ele conclui o fluxo de cancelamento da assinatura (pesquisa de motivo do cancelamento).
Representação JSON |
---|
{ "cancelSurveyReason": integer, "userInputCancelReason": string } |
Campos | |
---|---|
cancelSurveyReason |
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 ao custo 4. Descobri um app melhor |
userInputCancelReason |
O motivo de 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 a jornada do usuário no app. Isso pode ser na forma de solicitar a confirmação do usuário ou personalizar a experiência para uma conversão bem-sucedida.
Representação JSON |
---|
{
"newPrice": {
object ( |
Campos | |
---|---|
newPrice |
O novo preço de renovação da assinatura se a mudança de preço for aceita pelo usuário. |
state |
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 aceitação do usuário. Nesse estado, você tem a opção de 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 vai ser renovada, a menos que seja cancelada. A mudança de preço vai entrar em vigor na próxima data em que a assinatura for renovada. Observe que a mudança pode não ocorrer quando a assinatura for renovada. |
Métodos |
|
---|---|
|
Confirma a compra de uma assinatura. |
|
Cancela a compra da assinatura de um usuário. |
|
Adia a compra da assinatura de um usuário até um prazo de validade especificado. |
|
Verifica se a compra de assinatura de um usuário é válida e retorna o prazo de validade. |
|
Reembolsa a assinatura de um usuário, mas a assinatura permanece válida até o prazo de validade e é recorrente. |
|
Reembolsa e revoga imediatamente a compra da assinatura de um usuário. |