REST Resource: purchases.subscriptionsv2

Recurso: SubscriptionPurchaseV2

Indica o status da compra de assinatura de um usuário.

Representação JSON
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  },
  "etag": string,
  "outOfAppPurchaseContext": {
    object (OutOfAppPurchaseContext)
  },
  "onHoldStateContext": {
    object (OnHoldStateContext)
  },
  "inGracePeriodStateContext": {
    object (InGracePeriodStateContext)
  }
}
Campos
kind

string

Este tipo representa um objeto SubscriptionPurchaseV2 no serviço androidpublisher.

regionCode

string

Código regional/país de faturamento do usuário no formato ISO 3166-1 alpha-2, no momento em que a assinatura foi concedida.

lineItems[]

object (SubscriptionPurchaseLineItem)

Informações no nível do item sobre a compra de uma assinatura. Os itens na mesma compra precisam estar todos com "AutoRenewingPlan" ou com "PrepaidPlan".

startTime

string (Timestamp format)

Data e hora em que a assinatura foi concedida. Este campo não é definido para assinaturas pendentes (a assinatura foi criada, mas aguarda pagamento durante a inscrição).

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

subscriptionState

enum (SubscriptionState)

O estado atual da assinatura.

linkedPurchaseToken

string

O token de compra da antiga assinatura, caso ela seja de algum dos tipos a seguir: * Reinscrição de uma assinatura cancelada, mas ativa * Upgrade/downgrade de uma assinatura prévia. * Conversão de assinatura pré-paga para renovação automática. * Conversão de assinatura com renovação automática para pré-paga. * Recarga de uma assinatura pré-paga.

pausedStateContext

object (PausedStateContext)

Contexto adicional sobre assinaturas pausadas. Presente apenas se o subscriptionState da assinatura for SUBSCRIPTION_STATE_PAUSED.

canceledStateContext

object (CanceledStateContext)

Contexto adicional sobre assinaturas canceladas. Presente apenas se o subscriptionState da assinatura for SUBSCRIPTION_STATE_CANCELED ou SUBSCRIPTION_STATE_EXPIRED.

testPurchase

object (TestPurchase)

Presente apenas se esta compra de assinatura for um teste.

acknowledgementState

enum (AcknowledgementState)

O estado de confirmação da assinatura.

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

Identificador da conta de usuário no serviço de terceiros.

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

Perfil de usuário associado às compras feitas com o "Assine com o Google".

etag

string

Tag de entidade que representa o estado atual da assinatura. O desenvolvedor vai apresentar esta ETag para ações de assinatura. Esta ETag está sempre presente em assinaturas pré-pagas e com renovação automática.

outOfAppPurchaseContext

object (OutOfAppPurchaseContext)

Contexto adicional para compras fora do app. Essas informações só estão presentes em compras de renovação de assinatura (feitas após a expiração da assinatura anterior do mesmo produto) realizadas pela central de assinaturas do Google Play. Esse campo será removido depois que você confirmar a assinatura.

onHoldStateContext

object (OnHoldStateContext)

Opcional. Contexto adicional sobre assinaturas no estado ON_HOLD. Presente apenas se o "subscriptionState" da assinatura for SUBSCRIPTION_STATE_ON_HOLD.

inGracePeriodStateContext

object (InGracePeriodStateContext)

Opcional. Contexto adicional sobre assinaturas no estado IN_GRACE_PERIOD. Presente apenas se o "subscriptionState" da assinatura for SUBSCRIPTION_STATE_IN_GRACE_PERIOD.

SubscriptionState

Os potenciais estados de uma assinatura. Por exemplo, ativa ou cancelada. Os itens de uma compra de assinatura podem ser todos planos com renovação automática ou planos pré-pagos.

Tipos enumerados
SUBSCRIPTION_STATE_UNSPECIFIED Estado de assinatura não especificado.
SUBSCRIPTION_STATE_PENDING A assinatura foi criada, mas aguarda pagamento durante a inscrição. Neste estado, todos os itens aguardam pagamento.
SUBSCRIPTION_STATE_ACTIVE A assinatura está ativa. — (1) Se a assinatura for um plano com renovação automática, pelo menos um item será "autoRenewEnabled" e válido. — (2) Se a assinatura for um plano pré-pago, pelo menos um item será válido.
SUBSCRIPTION_STATE_PAUSED A assinatura está pausada. Este estado só fica disponível quando a assinatura é um plano com renovação automática. Neste estado, todos os itens também estão pausados.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD A assinatura está no período de carência. Este estado só fica disponível quando a assinatura é um plano com renovação automática. Neste estado, todos os itens também estão no período de carência.
SUBSCRIPTION_STATE_ON_HOLD A assinatura está pausada (suspensa). Este estado só fica disponível quando a assinatura é um plano com renovação automática. Neste estado, todos os itens também estão pausados.
SUBSCRIPTION_STATE_CANCELED A assinatura foi cancelada, mas ainda não expirou. Este estado só fica disponível quando a assinatura é um plano com renovação automática. Todos os itens têm "autoRenewEnabled" definido como "false".
SUBSCRIPTION_STATE_EXPIRED A assinatura expirou. O "expiryTime" de todos os itens está no passado.
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED Uma transação pendente para a assinatura foi cancelada. Se essa compra pendente era para uma assinatura existente, use linkedPurchaseToken para receber o estado atual da assinatura.

PausedStateContext

Informações específicas sobre uma assinatura no estado pausado.

Representação JSON
{
  "autoResumeTime": string
}
Campos
autoResumeTime

string (Timestamp format)

Data e hora em que a assinatura será automaticamente retomada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CanceledStateContext

Informações específicas sobre uma assinatura no estado SUBSCRIPTION_STATE_CANCELED ou SUBSCRIPTION_STATE_EXPIRED.

Representação JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of mutually exclusive fields.
}
Campos
O motivo do cancelamento de uma assinatura. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
userInitiatedCancellation

object (UserInitiatedCancellation)

A assinatura foi cancelada pelo usuário.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

A assinatura foi cancelada pelo sistema, por exemplo, por causa de um problema de faturamento.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

A assinatura foi cancelada pelo desenvolvedor.

replacementCancellation

object (ReplacementCancellation)

A assinatura foi substituída por uma nova.

Fim dos campos mutuamente exclusivos.

UserInitiatedCancellation

Informações específicas sobre cancelamentos feitos por usuários.

Representação JSON
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
Campos
cancelSurveyResult

object (CancelSurveyResult)

Informações enviadas pelo usuário ao completar o fluxo de cancelamento de assinatura (a pesquisa sobre o motivo do cancelamento).

cancelTime

string (Timestamp format)

A data e a hora em que a assinatura foi cancelada pelo usuário. Talvez o usuário ainda tenha acesso à assinatura após esse momento. Use lineItems.expiry_time para determinar se um usuário ainda tem acesso.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CancelSurveyResult

Resultado da pesquisa quando a assinatura foi cancelada pelo usuário.

Representação JSON
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
Campos
reason

enum (CancelSurveyReason)

O motivo selecionado pelo usuário na pesquisa de cancelamento.

reasonUserInput

string

Definido apenas para CANCEL_SURVEY_REASON_OTHERS. Esta é a resposta livre dada pelo usuário na pesquisa.

CancelSurveyReason

O motivo selecionado pelo usuário na pesquisa de cancelamento.

Tipos enumerados
CANCEL_SURVEY_REASON_UNSPECIFIED Motivo não especificado.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE O usuário não usou muito a assinatura.
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES Problemas técnicos ao usar o app.
CANCEL_SURVEY_REASON_FOUND_BETTER_APP O usuário encontrou um app melhor.
CANCEL_SURVEY_REASON_OTHERS Outros motivos.

SystemInitiatedCancellation

Esse tipo não tem campos.

Informações específicas sobre cancelamentos iniciados pelo sistema do Google.

DeveloperInitiatedCancellation

Esse tipo não tem campos.

Informações específicas sobre cancelamentos iniciados por desenvolvedores.

ReplacementCancellation

Esse tipo não tem campos.

Informações específicas sobre cancelamentos causados por substituição de assinatura.

TestPurchase

Esse tipo não tem campos.

Indica se esta compra de assinatura foi um teste.

AcknowledgementState

Os possíveis estados de confirmação de uma assinatura.

Tipos enumerados
ACKNOWLEDGEMENT_STATE_UNSPECIFIED Estado de confirmação não especificado.
ACKNOWLEDGEMENT_STATE_PENDING A assinatura ainda não foi confirmada.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED A assinatura foi confirmada.

ExternalAccountIdentifiers

Identificador da conta de usuário no serviço de terceiros.

Representação JSON
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Campos
externalAccountId

string

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

obfuscatedExternalAccountId

string

Uma versão ofuscada do ID que é exclusivamente associado com a conta do usuário no seu app. Presente nas seguintes compras: * Se a vinculação de contas tiver ocorrido como parte do fluxo de compra da assinatura. * Foi especificada 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 associado com o perfil do usuário no seu app. Presente apenas se especificada usando https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid quando a compra foi feita.

SubscribeWithGoogleInfo

Informações associadas a compras feitas com o Assine com o Google.

Representação JSON
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
Campos
profileId

string

O ID do perfil do Google do usuário quando a assinatura foi comprada.

profileName

string

O nome do perfil do usuário quando a assinatura foi comprada.

emailAddress

string

O endereço de e-mail do usuário quando a assinatura foi comprada.

givenName

string

O nome do usuário quando a assinatura foi comprada.

familyName

string

O sobrenome do usuário quando a assinatura foi comprada.

SubscriptionPurchaseLineItem

Informações no nível do item sobre a compra de uma assinatura.

Representação JSON
{
  "productId": string,
  "expiryTime": string,
  "developerTargetedOffers": [
    {
      object (DeveloperTargetedOffer)
    }
  ],
  "latestSuccessfulOrderId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of mutually exclusive fields.
  "offerDetails": {
    object (OfferDetails)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of mutually exclusive fields.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  },
  "offerPhase": {
    object (OfferPhase)
  }
}
Campos
productId

string

O ID do produto comprado (por exemplo, "monthly001").

expiryTime

string (Timestamp format)

Data e hora em que a assinatura expirou ou vai expirar, a não ser que o acesso seja estendido (por exemplo, renovações).

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

developerTargetedOffers[]

object (DeveloperTargetedOffer)

Opcional. Detalhes das ofertas para desenvolvedores registradas para este item de linha.

latestSuccessfulOrderId

string

O código do pedido do último pedido bem-sucedido associado a este item. Não estará presente se o item ainda não pertencer ao usuário (por exemplo, o item que está sendo substituído de forma adiada).

O tipo de plano de assinatura. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
autoRenewingPlan

object (AutoRenewingPlan)

O item tem renovação automática.

prepaidPlan

object (PrepaidPlan)

O item é pré-pago.

Fim dos campos mutuamente exclusivos.
offerDetails

object (OfferDetails)

Os detalhes de oferta para esse item.

Este campo está presente quando um item tem uma mudança adiada. Ele pode ser removido ou substituído. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
deferredItemReplacement

object (DeferredItemReplacement)

Informações para a substituição do item adiado.

deferredItemRemoval

object (DeferredItemRemoval)

Informações para a remoção do item adiado.

Fim dos campos mutuamente exclusivos.
signupPromotion

object (SignupPromotion)

Detalhes da promoção sobre este item. Definido somente se uma promoção foi aplicada durante a inscrição.

itemReplacement

object (ItemReplacement)

Detalhes do item que está sendo substituído. Esse campo só é preenchido se o item tiver substituído outro em uma assinatura anterior e só fica disponível por 60 dias após o momento da compra.

offerPhase

object (OfferPhase)

Detalhes da fase atual da oferta para este item.

AutoRenewingPlan

Informações sobre um plano com renovação automática.

Representação JSON
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  },
  "planTransitionDetails": {
    object (PlanTransitionDetails)
  },
  "priceStepUpConsentDetails": {
    object (PriceStepUpConsentDetails)
  }
}
Campos
autoRenewEnabled

boolean

Se a assinatura está definida para se renovar automaticamente.Por exemplo, o usuário não cancelou a assinatura.

recurringPrice

object (Money)

O preço recorrente atual do plano com renovação automática. O preço não considera descontos nem inclui tributos. Para preços sem tributos, chame a API orders.get se os detalhes da transação forem necessários.

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

Informações sobre a última mudança de preço do item desde a inscrição na assinatura.

installmentDetails

object (InstallmentPlan)

A fidelidade do plano de parcelas e informações sobre o estado do plano com renovação automática.

planTransitionDetails

object (PlanTransitionDetails)

Informações sobre a transição de plano associada. Só estará presente se este plano tiver um plano de transição associado a ele e só vai incluir os detalhes mais recentes associados ao item.

SubscriptionItemPriceChangeDetails

Informações sobre um item de assinatura relacionadas à mudanças de preço.

Representação JSON
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
Campos
newPrice

object (Money)

Novo preço recorrente para o item de assinatura.

priceChangeMode

enum (PriceChangeMode)

O modo de mudança de preço especifica como o preço do item de assinatura vai mudar.

priceChangeState

enum (PriceChangeState)

Estado atual da mudança de preço.

expectedNewPriceChargeTime

string (Timestamp format)

A data e a hora em que a mudança de preço vai entrar em vigor para o usuário. Sujeito a mudanças (para um momento futuro) devido a casos em que o horário da renovação é alterado, como em pausas. Esse campo só é preenchido se a mudança de preço ainda não tiver entrado em vigor.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

PriceChangeMode

O modo da mudança de preço.

Tipos enumerados
PRICE_CHANGE_MODE_UNSPECIFIED Modo de mudança de preço não especificado. Este valor nunca pode ser definido.
PRICE_DECREASE Se o preço da assinatura está diminuindo.
PRICE_INCREASE Se o preço da assinatura está aumentando e o usuário precisa aceitar.
OPT_OUT_PRICE_INCREASE Se o preço da assinatura está aumentando com o modo "recusar".

PriceChangeState

O estado da mudança de preço.

Tipos enumerados
PRICE_CHANGE_STATE_UNSPECIFIED Estado da mudança de preço não especificado. Este valor não deve ser usado.
OUTSTANDING Esperando o usuário aceitar a mudança de preço.
CONFIRMED A mudança de preço está confirmada e vai acontecer para o usuário.
APPLIED A mudança de preço foi aplicada. Por exemplo, o novo preço já está sendo cobrado do usuário.
CANCELED A mudança de preço foi cancelada.

InstallmentPlan

Informações sobre um plano parcelado.

Representação JSON
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
Campos
initialCommittedPaymentsCount

integer

O número total de parcelas que o usuário se comprometeu a pagar inicialmente.

subsequentCommittedPaymentsCount

integer

O número total de parcelas que o usuário vai precisar pagar depois de cada período de fidelidade. Um campo vazio significa que o plano parcelado vai voltar a ser uma assinatura normal com renovação automática depois da fidelidade inicial.

remainingCommittedPaymentsCount

integer

O número total de parcelas que ainda precisam ser pagas neste ciclo de renovação.

pendingCancellation

object (PendingCancellation)

Se estiver presente, o cancelamento deste plano parcelado está pendente. O cancelamento vai acontecer apenas depois de o usuário terminar de pagar todas as parcelas.

PendingCancellation

Esse tipo não tem campos.

Indica se há um cancelamento pendente no plano parcelado virtual. O cancelamento vai acontecer apenas depois de o usuário terminar de pagar todas as parcelas.

PlanTransitionDetails

Informações sobre uma transição de plano.

Representação JSON
{
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "transitionInfo": {
    object (TransitionInfo)
  }
}
Campos
productId

string

[Obrigatório] O ID do produto que receberá a transferência deste plano (por exemplo, "monthly001").

basePlanId

string

[Obrigatório] O ID do plano básico que receberá a transferência deste plano.

offerId

string

O ID da oferta. Presente apenas em ofertas com desconto. Isso só será definido se o plano de destino não for um plano básico.

transitionInfo

object (TransitionInfo)

Informações adicionais sobre a transição de plano programada. Só estará presente se uma transição de plano tiver sido programada.

TransitionInfo

Informações sobre uma transição de plano programada.

Representação JSON
{
  "transitionState": enum (TransitionState),
  "price": {
    object (Money)
  },
  "expectedTransitionTime": string
}
Campos
transitionState

enum (TransitionState)

Apenas saída. [Obrigatório] O estado atual da transição.

price

object (Money)

O preço padrão do plano básico que receberá a transferência do plano.

expectedTransitionTime

string (Timestamp format)

A data e a hora esperadas para a transição do plano. Sujeitas a mudanças (para um momento futuro) devido a casos em que o horário da renovação é alterado, como em pausas e suspensão de conta.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

TransitionState

Os potenciais estados em que uma transição pode estar.

Tipos enumerados
TRANSITION_STATE_UNSPECIFIED Estado de transição não especificado.
SCHEDULED A transição está programada para começar no futuro.
IN_PROGRESS O processo de transição começou e a notificação inicial foi enviada ao usuário.
COMPLETED A transição foi concluída.
CANCELED A transição foi cancelada.

PriceStepUpConsentDetails

Informações relacionadas a um aumento de preço que exige o consentimento do usuário.

Representação JSON
{
  "state": enum (ConsentState),
  "consentDeadlineTime": string,
  "newPrice": {
    object (Money)
  }
}
Campos
state

enum (ConsentState)

Apenas saída. O estado do consentimento para o aumento de preço.

consentDeadlineTime

string (Timestamp format)

O prazo para o usuário dar o consentimento. Se o consentimento não for dado até essa data, a assinatura será cancelada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

newPrice

object (Money)

O novo preço que exige o consentimento do usuário.

ConsentState

O estado do consentimento para o aumento de preço.

Tipos enumerados
CONSENT_STATE_UNSPECIFIED Estado de consentimento não especificado.
PENDING O usuário ainda não deu consentimento.
CONFIRMED O usuário aceitou, e o novo preço está aguardando para entrar em vigor.
COMPLETED O usuário consentiu, e o novo preço entrou em vigor.

PrepaidPlan

Informações sobre um plano pré-pago.

Representação JSON
{
  "allowExtendAfterTime": string
}
Campos
allowExtendAfterTime

string (Timestamp format)

Se presente, é o momento em que recargas são permitidas para o plano pré-pago. Não estará presente em planos pré-pagos expirados.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

OfferDetails

Informações sobre ofertas relacionadas a um item de linha de compra.

Representação JSON
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
Campos
offerTags[]

string

As últimas tags associadas à oferta. Inclui tags herdadas do plano básico.

basePlanId

string

O ID do plano básico. Presente em todos os planos básicos e ofertas.

offerId

string

O ID da oferta. Presente apenas em ofertas com desconto.

DeferredItemReplacement

Informações sobre uma substituição de item adiada.

Representação JSON
{
  "productId": string
}
Campos
productId

string

O "productId" que vai substituir o "productId" atual.

DeferredItemRemoval

Esse tipo não tem campos.

Informações sobre uma substituição de item adiada.

SignupPromotion

A promoção aplicada a esse item quando comprado.

Representação JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of mutually exclusive fields.
}
Campos
O tipo de promoção aplicado ao item. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
oneTimeCode

object (OneTimeCode)

Um código de uso único foi aplicado.

vanityCode

object (VanityCode)

Um código personalizado foi aplicado.

Fim dos campos mutuamente exclusivos.

OneTimeCode

Esse tipo não tem campos.

Um código promocional de uso único.

VanityCode

Um código promocional predefinido de uso múltiplo.

Representação JSON
{
  "promotionCode": string
}
Campos
promotionCode

string

O código promocional.

ItemReplacement

Detalhes sobre um item de linha de assinatura que está sendo substituído.

Representação JSON
{
  "productId": string,
  "replacementMode": enum (ReplacementMode),
  "basePlanId": string,
  "offerId": string
}
Campos
productId

string

O ID do produto do item de linha da assinatura que está sendo substituído.

replacementMode

enum (ReplacementMode)

O modo de substituição aplicado durante a compra.

basePlanId

string

É o ID do plano básico do item de linha da assinatura que está sendo substituído.

offerId

string

É o ID da oferta do item de linha da assinatura que está sendo substituído, se aplicável.

ReplacementMode

O modo de substituição de uma assinatura.

Tipos enumerados
REPLACEMENT_MODE_UNSPECIFIED Modo de substituição não especificado.
WITH_TIME_PRORATION O novo plano será proporcional e creditado do plano antigo.
CHARGE_PRORATED_PRICE O usuário vai receber uma cobrança proporcional pelo novo plano.
WITHOUT_PRORATION O novo plano vai substituir o antigo sem proporcionalidade de tempo.
CHARGE_FULL_PRICE O usuário vai receber a cobrança do preço total do novo plano.
DEFERRED O plano antigo será cancelado, e o novo entrará em vigor após o vencimento do antigo.
KEEP_EXISTING O plano não vai mudar com essa substituição.

OfferPhase

Detalhes da fase da promoção.

Representação JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prorationPeriod": {
    object (ProrationPeriodOfferPhase)
  },
  "freeTrial": {
    object (FreeTrialOfferPhase)
  },
  "introductoryPrice": {
    object (IntroductoryPriceOfferPhase)
  },
  "basePrice": {
    object (BasePriceOfferPhase)
  }
  // End of mutually exclusive fields.
}
Campos
Os detalhes da fase da promoção. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
prorationPeriod

object (ProrationPeriodOfferPhase)

Definido quando a fase da oferta é um período de cálculo proporcional.

freeTrial

object (FreeTrialOfferPhase)

Defina quando a fase da oferta for um teste sem custo financeiro.

introductoryPrice

object (IntroductoryPriceOfferPhase)

Defina quando a fase da promoção for uma fase de promoção de preço inicial.

basePrice

object (BasePriceOfferPhase)

Definido quando a fase da promoção é uma fase de preços do plano básico.

Fim dos campos mutuamente exclusivos.

ProrationPeriodOfferPhase

Detalhes sobre a fase de oferta do período de cálculo proporcional.

Representação JSON
{
  "originalOfferPhaseType": enum (OriginalOfferPhaseType)
}
Campos
originalOfferPhaseType

enum (OriginalOfferPhaseType)

O tipo de fase da oferta original antes do período de cálculo proporcional. Definido apenas quando o período de cálculo proporcional é atualizado de uma fase de oferta atual.

OriginalOfferPhaseType

A fase da oferta original do pagamento da oferta, se o pagamento for proporcional.

Tipos enumerados
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED Tipo de fase da oferta original não especificado.
BASE A assinatura está na fase de preço base (por exemplo, preço total).
INTRODUCTORY A assinatura está em uma fase de preço inicial.
FREE_TRIAL A assinatura está em um teste sem custo financeiro.

FreeTrialOfferPhase

Esse tipo não tem campos.

Detalhes sobre a fase da oferta de teste sem custo financeiro.

IntroductoryPriceOfferPhase

Esse tipo não tem campos.

Detalhes sobre a fase de oferta de preço inicial.

BasePriceOfferPhase

Esse tipo não tem campos.

Detalhes sobre a fase de oferta do preço base.

DeveloperTargetedOffer

Informações sobre uma oferta para desenvolvedores de um item de linha de assinatura.

Representação JSON
{
  "offerId": string,
  "activateTime": string
}
Campos
offerId

string

Opcional. É o ID da oferta criada pelo desenvolvedor para a assinatura.

activateTime

string (Timestamp format)

Opcional. Horário em que a segmentação da oferta foi ativada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

OutOfAppPurchaseContext

Informações específicas sobre uma compra fora do app.

Representação JSON
{
  "expiredExternalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "expiredPurchaseToken": string
}
Campos
expiredExternalAccountIdentifiers

object (ExternalAccountIdentifiers)

Identificador da conta de usuário da última assinatura expirada para essa SKU.

expiredPurchaseToken

string

O token de compra da última assinatura expirada. Esse token de compra só deve ser usado para ajudar a identificar o usuário se o link entre o purchaseToken e o usuário estiver armazenado no seu banco de dados. Ele não poderá ser usado para chamar a API Google Developer se tiver expirado há mais de 60 dias.

OnHoldStateContext

Contexto adicional sobre assinaturas no estado ON_HOLD.

Representação JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
Campos
O motivo pelo qual a assinatura está no estado ON_HOLD. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
renewalDeclined

object (RenewalDeclinedContext)

Opcional. O pagamento da renovação foi recusado.

Fim dos campos mutuamente exclusivos.

RenewalDeclinedContext

Contexto relacionado ao cenário de renovação recusada.

Representação JSON
{
  "pendingOrderId": string
}
Campos
pendingOrderId

string

Obrigatório. O ID do pedido pendente ou com falha que está causando o estado.

InGracePeriodStateContext

Contexto adicional sobre assinaturas no estado IN_GRACE_PERIOD.

Representação JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
Campos
O motivo pelo qual a assinatura está no estado IN_GRACE_PERIOD. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
renewalDeclined

object (RenewalDeclinedContext)

Opcional. O pagamento da renovação foi recusado.

Fim dos campos mutuamente exclusivos.

Métodos

activateoffertargeting

Ativa a segmentação para uma oferta específica.

cancel

Cancela a compra de uma assinatura para o usuário.

cancelplantransition

Cancela uma transição de plano para uma assinatura.

deactivateoffertargeting

Desativa a segmentação de uma oferta específica.

defer

Adia a renovação de uma assinatura.

get

Recebe metadados sobre uma assinatura

revoke

Revoga a compra de assinatura para o usuário.

scheduleplantransition

Programa uma transição de plano para uma assinatura.

Códigos de erro

As operações desse recurso retornam os seguintes códigos de erro HTTP:

Código do erro Motivo Descrição Resolução
400 / 410 subscriptionExpired A assinatura expirou, e a operação solicitada não pode ser realizada. Verifique o prazo de validade da assinatura. Esta operação não é permitida em assinaturas expiradas.
400 subscriptionInvalidArgument Um argumento inválido foi fornecido na solicitação da assinatura. Consulte a documentação da API e verifique se todos os campos obrigatórios foram preenchidos e formatados corretamente.
400 invalidPurchaseState A compra não está em um estado válido para realizar a operação solicitada. Por exemplo, você pode estar tentando confirmar uma compra já consumida ou cancelar uma assinatura que não está ativa. Verifique o estado atual do recurso usando a API Get correspondente antes de tentar a operação. Verifique se o recurso está em um estado apropriado para a ação.
400 invalidValue Um valor inválido foi fornecido na solicitação. Isso geralmente é retornado para um token de compra inválido ou com formato incorreto. Corrija o valor do campo inválido no corpo ou nos parâmetros da solicitação com base na referência da API.
400 prepaidSubscriptionNotSupported A operação solicitada não é aceita para assinaturas pré-pagas. Verifique se a operação é aplicável ao tipo de assinatura. Esse erro é específico de métodos como Cancel.
400 productNotOwnedByUser O token de compra fornecido é válido, mas o usuário não é o proprietário do produto no momento. Isso pode acontecer se a compra for reembolsada, revogada ou expirar antes da confirmação. Verifique o estado atual do recurso usando a API Get correspondente antes de tentar a operação. Verifique se o recurso está em um estado apropriado para a ação.
400 purchaseTokenMismatch O token de compra fornecido não corresponde à compra, ao nome do pacote, ao ID da assinatura ou ao ID do produto. Verifique se todos os detalhes na solicitação estão corretos e correspondem uns aos outros.
400 required Um campo ou parâmetro obrigatório está ausente na solicitação. Consulte a documentação da API para garantir que todos os campos e parâmetros obrigatórios sejam incluídos.
400 unsupportedIabType A operação não é compatível com o tipo de faturamento no app fornecido. Verifique se o método da API é compatível com o tipo de item que está sendo gerenciado.
403 userInsufficientPermission O usuário não tem permissão suficiente para realizar a operação solicitada. Verifique se o usuário autenticado tem as permissões necessárias no Google Play Console. Consulte Como usar uma conta de serviço para mais detalhes.
404 notFound Não foi possível encontrar o recurso solicitado. Verifique se os identificadores (por exemplo, token de compra, nome do pacote, ID do produto, ID da assinatura) estão corretos.
409 concurrentUpdate Houve uma tentativa de atualizar um objeto que está sendo atualizado simultaneamente. Tente novamente com a espera exponencial. Evite modificações simultâneas no mesmo recurso.
410 purchaseTokenNoLongerValid O token de compra é permanentemente inválido porque a conta de usuário associada foi excluída ou o registro de compra não existe mais. Interrompa o uso desse token de compra.
410 subscriptionNoLongerAvailable A compra da assinatura não está mais disponível para consulta porque expirou há muito tempo. Esse erro indica que a assinatura expirou há mais de 60 dias. Não consulte mais essas assinaturas.
5xx Generic error Erro genérico no servidor do Google Play. Tente fazer a solicitação novamente.

Se o problema persistir, entre em contato com o gerente de contas do Google Play ou envie uma solicitação de suporte. Confira o painel de status do Google Play para ver se há interrupções conhecidas.