Lista os ciclos de cobrança de uma assinatura
/v1/subscriptions/{subscriptionId}/cyclesAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros do caminho
subscriptionIdstringobrigatórioIdentificador público (subs_/sub_…)
Parâmetros de consulta
limitintegerTamanho da página (itens por página).
offsetintegerPosição do primeiro item (a partir de 0).
sortstringExpressão de ordenação, ex.: "-createdAt"
daterangeum deCriados neste dia (
YYYY-MM-DD) ou neste instante.daterangegtstring (date-time)Criados depois deste instante (exclusivo).
daterangegtestring (date-time)Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)Criados antes deste instante (exclusivo).
daterangeltestring (date-time)Criados até este instante (inclusivo).
statusstringSó ciclos com este status.
Valores:scheduledprocessingpaidfailedcanceled
Respostas
200Sucesso
dataobject[]obrigatórioOs itens desta página.
+18 campos de
dataidstringobrigatórioIdentificador público (scy_/cycle_…)
cycleintegerobrigatórioNúmero do ciclo (1 = o primeiro).
_linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).amountintegerobrigatóriopode ser nuloValor da última cobrança ligada ao ciclo, em centavos;
nullquando não há.methodstringobrigatóriopode ser nuloMeio de pagamento dessa cobrança;
nullquando não há.statusstringobrigatórioStatus do ciclo:
scheduled,processing,paid,failedoucanceled.dueDatestringobrigatórioQuando o ciclo é cobrado (ou vence).
endDatestringobrigatóriopode ser nuloQuando o ciclo termina;
nullenquanto aberto.failureobjectobrigatóriopode ser nuloPor que o ciclo falhou;
nullquando não falhou, ou quando o motivo não foi registrado.+4 campos de
failureatstringobrigatóriopode ser nuloQuando falhou.
codestringobrigatóriopode ser nuloCódigo estável da falha (
noCard,noBillingAddress,unpriceableItems, ou o código de recusa da cobrança).stagestringobrigatóriobeforeCharge: a cobrança nunca foi tentada (sem cartão, boleto sem endereço, item sem preço);charge: o pagamento foi recusado.Valores:beforeChargechargemessagestringobrigatóriopode ser nuloA mensagem da recusa, quando a cobrança foi tentada.
attemptsintegerobrigatórioTentativas de cobrança até agora (o limite de retentativas é 5).
billedAtstringobrigatóriopode ser nuloQuando o ciclo foi cobrado;
nullaté lá.merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
startDatestringobrigatórioQuando o ciclo começa.
updatedAtstringobrigatórioQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
nextAttemptAtstringobrigatóriopode ser nuloQuando um ciclo falho é tentado de novo;
nullquando não será.transactionIdstringobrigatóriopode ser nuloA última cobrança ligada ao ciclo;
nullquando não há.expectedAmountintegerobrigatóriopode ser nuloNo ciclo em aberto: o que ele cobraria agora, em centavos;
nullnos outros, ou quando ainda não dá para saber.
pageobjectobrigatórioCursores de paginação da lista.
+3 campos de
pagetotalintegerobrigatórioNúmero total de páginas.
offsetobjectobrigatórioO
offsetpara pedir a primeira, a anterior, a próxima e a última página.+4 campos de
offsetlastintegerobrigatórioPosição da última página.
nextintegerobrigatórioPosição da próxima página (fica nesta quando ela é a última).
previntegerobrigatórioPosição da página anterior (0 na primeira).
firstintegerobrigatórioPosição da primeira página.
currentintegerobrigatórioNúmero da página atual (a primeira é 1).
limitintegerobrigatórioTamanho da página, como pedido.
totalintegerobrigatórioNúmero total de itens que atendem aos filtros.
_linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).offsetintegerobrigatórioPosição do primeiro item desta página, como pedido.
hasMorebooleanobrigatóriotruequando há mais itens depois desta página.merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório