1. Assinantes
SYNC-DOCUMENTATION
  • Introdução
  • Auth Token
    • Gera o token de utilização da aplicação
      POST
  • Saldo
    • Retorna o Saldo do Usuário
      GET
  • Transações
    • Consultar transação V1
      GET
    • Consultar transação V2
      GET
  • Utmify
    • Salvar Token
      POST
    • Desativa Token
      POST
  • Partner
    • Consulta dados do Parceiro
      GET
  • Cartão de Crédito
    • Tokenização pública de cartão
    • IFrame
    • Cobrar no cartão
      POST
  • Pix - CashIn
    • Solicitação de depósito via Pix
      POST
  • Old API
    • CashIn
      POST
    • Consulta os dados do Parceiro
      GET
  • Assinaturas - Recorrência
    • Assinatura com Cartão de Crédito
    • Planos
      • Listar planos
      • Criar plano
      • Detalhe do plano
      • Assinantes do plano
    • Assinantes
      • Cadastrar assinante
      • Listar assinantes
      • Detalhe da assinatura
      • Cancelar assinatura
      • Pausar assinatura
      • Reativar assinatura
      • Trocar plano da assinatura
    • Notificações
      • Listar entregas de um webhook
    • Produtos — Planos
      • Listar planos aninhados a um produto
      • Criar plano aninhado a um produto
      • Marcar plano como padrão do produto
  • Reembolsos
    • Solicitar reembolso de uma venda
    • Consultar uma solicitação de reembolso
  • Webhooks
    • Cash-In
      • Cash-in criado (cobrança PIX gerada)
      • Cash-in atualizado (mudança de status)
      • Cash-in legado (notificação mínima)
    • Cash-Out
      • Cash-out criado (saque solicitado)
      • Cash-out atualizado (mudança de status do saque)
    • Cartão de Crédito
      • Cartão de crédito — cobrança criada
      • Cartão de crédito — mudança de status
    • Transações - Completo
      • Cobrança de transação criada
      • Transação teve mudança de status
    • Listar webhooks
    • Criar webhook
    • Atualizar webhook
    • Excluir webhook
    • Rotacionar o segredo de assinatura
  • Raiz
    • iFrame de pagamento (cartão e Apple Pay)
    • Planos
      • Catálogo do que pode ser cobrado
    • Assinantes
      • Cobranças da assinatura (e as próximas)
        GET
    • Notificações
      • Listar webhooks
      • Criar webhook
      • Atualizar webhook
      • Remover webhook
  • Esquemas
    • Webhook
      • CashIn
        • onCreate
        • onUpdate
        • CashinCreated
        • CashinUpdated
        • CashinOld
      • CashOut
        • onCreate
        • onUpdate
      • Cash-In
        • CashinCreated
        • CashinUpdated
        • CashinOld
    • CashinCreated
    • WebhookInput
    • CardTokenRequest
    • CreditCardPaymentRequest
    • Message
    • RefundReason
    • CreditCardCreated
    • Transaction
    • TransactionEvent
    • BillingMethod
    • CashoutCreated
    • CreditCardCreatePayload
    • RefundStatus
    • CreditCardPaymentAccepted
    • CardToken
    • CreditCardStatusPayload
    • CashinUpdated
    • Webhook
    • CashoutUpdated
    • CreditCardUpdated
    • TransactionV2
    • PlanStatus
    • RefundWebhookPayload
    • RefundRejectionCategory
    • CashinOld
    • Customer
    • CreatedWebhook
    • SplitStatus
    • WebhookListItem
    • DebtorAccount
    • SubscriptionSplit
    • PaymentMethod
    • RefundRequest
    • SimpleError
    • WebhookDelivery
    • SplitRecipientPayload
    • CodedError
    • Payment
    • RotatedWebhookSecret
    • StoreProductPlanRequest
    • PlanResource
    • SubscriptionSplitInvite
    • RefundTransaction
    • Card
    • Checkout
    • UpdateProductPlanRequest
    • RefundEvent
    • RefusedError
    • PlanContext
    • SubscriptionStatus
    • PaymentLink
    • AntiFraudError
    • ChargeStatus
    • PaymentStatus
    • Error
    • SubscriptionSplitItem
    • Tracking
    • ChargeAttemptResource
    • DeliveryAddress
    • UpcomingCharges
    • EnrollTargetRejected
    • PaginationMeta
    • CatalogPlan
    • ProblemJson
    • ChargeResource
    • SubscriptionResource
    • WebhookResource
    • NotFoundError
    • ValidationError
    • EnrollPaymentQrCode
    • EnrollPaymentPixAutomatico
    • ChargeBlock
    • EnrollPaymentCreditCard
    • WebhookDeliveryResource
    • WebhookEnvelope
    • MandateBlock
  1. Assinantes

Cobranças da assinatura (e as próximas)

GET
/api/partner/v1/subscriptions/{token}/charges
Todas as cobranças da assinatura, da mais nova para a mais antiga, com
as tentativas de cada uma, mais o bloco upcoming com até 3 cobranças
futuras. Escopo subscriptions:read.
Token inexistente e token de outra conta respondem o mesmo 404, com
o mesmo corpo de GET /subscriptions/{token}, em v1 e em v2.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros de Caminho

Parâmetros de Consulta

Respostas

🟢200
application/json
Cobranças paginadas e próximas cobranças.
Bodyapplication/json

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/partner/v1/subscriptions//charges?per_page=&page=' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Sucesso
{
    "data": [
        {
            "id": 812,
            "cycle_number": 2,
            "attempts_count": 1,
            "amount": "49.90",
            "status": "failed",
            "due_date": "2026-10-20",
            "expires_at": null,
            "paid_at": null,
            "billing_method": "pix_automatico",
            "attempts": [
                {
                    "id": 77,
                    "attempted_at": "2026-10-20T15:00:00+00:00",
                    "status": "failed",
                    "failure_reason": "insufficient_funds",
                    "amount": "49.90",
                    "provider": "woovi"
                }
            ],
            "payment": {
                "pix_code": null,
                "qr_code": null
            }
        }
    ],
    "upcoming": {
        "items": [
            {
                "cycle_number": 3,
                "due_date": "2026-11-19",
                "amount": "49.90",
                "billing_method": "pix_automatico",
                "projected": false
            },
            {
                "cycle_number": 4,
                "due_date": "2026-12-19",
                "amount": "49.90",
                "billing_method": "pix_automatico",
                "projected": true
            }
        ],
        "remaining_cycles": null
    },
    "meta": {
        "current_page": 1,
        "per_page": 50,
        "total": 1,
        "last_page": 1
    }
}
Modificado em 2026-10-30 00:52:45
Página anterior
Catálogo do que pode ser cobrado
Próxima página
Listar webhooks
Built with