Cuidado: você está vendo a documentação da interface REST da API. A maioria das nossas bibliotecas de cliente oficiais usa o gRPC. Consulte Introdução ao REST para ver mais detalhes.

Esta página foi traduzida pela API Cloud Translation.

BillingSetup

Representação JSON
BillingSetupStatus
PaymentsAccountInfo
- Representação JSON

Uma configuração de faturamento que associa uma conta para pagamentos e um anunciante. Uma configuração de faturamento é específica para um anunciante.

Representação JSON

Representação JSON
{ "resourceName": string, "status": enum (`BillingSetupStatus`), "paymentsAccountInfo": { object (`PaymentsAccountInfo`) }, "id": string, "paymentsAccount": string, // Union field `start_time` can be only one of the following: "startDateTime": string, "startTimeType": enum (`TimeType`) // End of list of possible types for union field `start_time`. // Union field `end_time` can be only one of the following: "endDateTime": string, "endTimeType": enum (`TimeType`) // End of list of possible types for union field `end_time`. }

{
  "resourceName": string,
  "status": enum (BillingSetupStatus),
  "paymentsAccountInfo": {
    object (PaymentsAccountInfo)
  },
  "id": string,
  "paymentsAccount": string,

  // Union field start_time can be only one of the following:
  "startDateTime": string,
  "startTimeType": enum (TimeType)
  // End of list of possible types for union field start_time.

  // Union field end_time can be only one of the following:
  "endDateTime": string,
  "endTimeType": enum (TimeType)
  // End of list of possible types for union field end_time.
}

Campos
`resourceName`	`string` Imutável. O nome do recurso da configuração de faturamento. Os nomes dos recursos de configuração de faturamento têm o seguinte formato: `customers/{customerId}/billingSetups/{billing_setup_id}`
`status`	`enum (BillingSetupStatus)` Apenas saída. O status da configuração de faturamento.
`paymentsAccountInfo`	`object (PaymentsAccountInfo)` Imutável. As informações da conta para pagamentos associada a essa configuração de faturamento. Ao configurar o faturamento, ele é usado para se inscrever em uma nova conta para pagamentos. Portanto, a conta para pagamentos não pode ser definida. Ao receber uma configuração de faturamento, essa e a paymentsAccount serão preenchidas.
`id`	`string (int64 format)` Apenas saída. O ID da configuração de faturamento.
`paymentsAccount`	`string` Imutável. O nome do recurso da conta para pagamentos associada a essa configuração de faturamento. Os nomes dos recursos de pagamentos têm o seguinte formato: `customers/{customerId}/paymentsAccounts/{paymentsAccountId}` Quando você configura o faturamento, ele é usado para se inscrever em uma conta para pagamentos existente. Nesse caso, o campo paymentsAccountInfo não precisa ser definido. Ao receber uma configuração de faturamento, esse campo e paymentsAccountInfo serão preenchidos.
Campo de união `start_time`. Ao criar uma nova configuração de faturamento, é quando ela entra em vigor. AGORA é o único horário de início aceitável se o cliente não tiver configurações aprovadas. Ao buscar uma configuração de faturamento existente, esse é o horário de início solicitado. No entanto, se a configuração tiver sido aprovada (consulte o status) após o horário de início solicitado, esse será o horário de aprovação. `start_time` pode ser apenas de um dos tipos a seguir:
`startDateTime`	`string` Imutável. A data e hora de início no formato AAAA-MM-DD ou AAAA-MM-DD HH:MM:SS. Apenas um horário futuro é permitido.
`startTimeType`	`enum (TimeType)` Imutável. A hora de início como um tipo. Somente "AGORA" é permitido.
Campo de união `end_time`. Quando a configuração de faturamento termina / terminou. Pode ser "FOREVER" (para sempre) ou o horário de início da próxima configuração de faturamento programada. `end_time` pode ser apenas de um dos tipos a seguir:
`endDateTime`	`string` Apenas saída. A data e hora de término no formato AAAA-MM-DD ou AAAA-MM-DD HH:MM:SS.
`endTimeType`	`enum (TimeType)` Apenas saída. O horário de término como um tipo. O único valor possível é FOREVER.

BillingSetupStatus

Os status possíveis de uma configuração de faturamento.

Enums
`UNSPECIFIED`	Não especificado.
`UNKNOWN`	Usado apenas para o valor de retorno. Representa um valor desconhecido nesta versão.
`PENDING`	A configuração de faturamento está pendente de aprovação.
`APPROVED_HELD`	A configuração de faturamento foi aprovada, mas o primeiro orçamento correspondente não. Isso só pode ocorrer em configurações de faturamento configuradas para faturamento mensal.
`APPROVED`	A configuração de faturamento foi aprovada.
`CANCELLED`	A configuração de faturamento foi cancelada pelo usuário antes da aprovação.

PaymentsAccountInfo

Contêiner de informações da conta para pagamentos deste faturamento.

Representação JSON
{ "paymentsAccountId": string, "paymentsAccountName": string, "paymentsProfileId": string, "paymentsProfileName": string, "secondaryPaymentsProfileId": string }

Campos
`paymentsAccountId`	`string` Apenas saída. Um ID de 16 dígitos usado para identificar a conta para pagamentos associada à configuração de faturamento. Ele precisa ser transmitido como uma string com traços, por exemplo, "1234-5678-9012-3456".
`paymentsAccountName`	`string` Imutável. O nome da conta para pagamentos associada à configuração de faturamento. Isso permite que o usuário especifique um nome significativo para uma conta de pagamentos para ajudar na reconciliação de faturas mensais. Esse nome será impresso nas faturas mensais.
`paymentsProfileId`	`string` Imutável. Um ID de 12 dígitos usado para identificar o perfil para pagamentos associado à configuração de faturamento. Ele precisa ser transmitido como uma string com traços, por exemplo, "1234-5678-9012".
`paymentsProfileName`	`string` Apenas saída. O nome do perfil para pagamentos associado à configuração de faturamento.
`secondaryPaymentsProfileId`	`string` Apenas saída. Um ID de perfil para pagamentos secundário presente em situações incomuns, por exemplo, quando um contrato de responsabilidade sequencial foi organizado.