1. Assinantes
SYNC-DOCUMENTATION
  • Auth Token
    • Gera o token de utilização da aplicação
      POST
  • Saldo
    • Retorna o Saldo do Usuário
      GET
  • Transações
    • Consulta status da transação
      GET
  • Utmify
    • Salvar Token
      POST
    • Desativa Token
      POST
  • Partner
    • Consulta dados do Parceiro
      GET
  • Pix - CashIn
    • Solicitação de depósito via Pix
      POST
  • Pix - CashOut
    • Solicitação de saque Pix
      POST
  • Webhooks
    • Cashin
      • Old
        • OnCreate/OnUpdate
      • OnCreate
      • OnUpdate
    • Cashout
      • OnCreate
      • OnUpdate
    • ListAll
      GET
    • Create
      POST
    • Update
      PUT
    • Delete
      DELETE
  • Old API
    • CashIn
    • Consulta os dados do Parceiro
  • Assinaturas - Recorrência
    • Planos
      • Listar planos
      • Criar plano
      • Detalhe do plano
      • Editar plano
      • Arquivar plano
      • Assinantes do plano
    • Assinantes
      • Listar assinantes
        GET
      • Detalhe da assinatura
        GET
      • Cancelar assinatura
        PATCH
      • Pausar assinatura
        PATCH
      • Reativar assinatura
        PATCH
      • Reenviar cobrança
        PATCH
  • Esquemas
    • Webhook
      • CashIn
        • onCreate
        • onUpdate
      • CashOut
        • onCreate
        • onUpdate
    • BillingMethod
    • PlanStatus
    • SubscriptionStatus
    • ChargeStatus
    • PlanResource
    • ChargeResource
    • SubscriptionResource
    • PaginationMeta
    • ValidationError
    • NotFoundError
  1. Assinantes

Detalhe da assinatura

GET
/api/partner/v1/subscriptions/{token}
Retorna os detalhes completos de uma assinatura, incluindo:
Dados do plano vinculado
Histórico das últimas 12 cobranças, da mais recente para a mais antiga
A cobrança mais recente com status: pending contém o pix_code para
pagamento imediato.

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

Respostas

🟢200
application/json
Detalhes da assinatura.
Bodyapplication/json

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/partner/v1/subscriptions/' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Sucesso
{
    "data": {
        "token": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "status": "active",
        "subscriber_name": "João Silva",
        "subscriber_email": "joao@email.com",
        "subscriber_document": "123.456.789-00",
        "subscriber_phone": "+5511999999999",
        "started_at": "2025-06-01T10:00:00.000000Z",
        "next_charge_at": "2025-07-01T10:00:00.000000Z",
        "overdue_since": null,
        "suspended_at": null,
        "cancelled_at": null,
        "retry_count": 0,
        "plan": {
            "token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "name": "Plano Mensal",
            "description": "Acesso completo à plataforma por 30 dias",
            "amount": 50,
            "periodicity_days": 30,
            "billing_advance_days": 3,
            "grace_period_days": 5,
            "max_retry_attempts": 3,
            "billing_method": "qr_code",
            "status": "active",
            "checkout_url": "https://app.syncpayments.com.br/subscription/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
        },
        "charges": [
            {
                "cycle_number": 2,
                "amount": 50,
                "status": "pending",
                "due_date": "2025-07-01",
                "expires_at": "2025-07-02T00:00:00.000000Z",
                "paid_at": null,
                "payment": {
                    "pix_code": "00020126360014BR.GOV.BCB.PIX0114+5511999999999...",
                    "qr_code": null
                }
            },
            {
                "cycle_number": 1,
                "amount": 50,
                "status": "paid",
                "due_date": "2025-06-01",
                "expires_at": "2025-06-02T00:00:00.000000Z",
                "paid_at": "2025-06-01T10:05:00.000000Z",
                "payment": {
                    "pix_code": "00020126360014BR.GOV.BCB.PIX0114+5511999999999...",
                    "qr_code": null
                }
            }
        ]
    }
}
Modificado em 2026-06-19 15:29:20
Página anterior
Listar assinantes
Próxima página
Cancelar assinatura
Built with