SYNC-DOCUMENTATION
    • Auth Token
      • Gera o token de utilização da aplicação
    • Saldo
      • Retorna o Saldo do Usuário
    • Transações
      • Consulta status da transação
    • Utmify
      • Salvar Token
      • Desativa Token
    • Partner
      • Consulta dados do Parceiro
    • Cartão de Crédito
      • Selar um cartão
      • Cobrar no cartão
    • Pix - CashIn
      • Solicitação de depósito via Pix
    • 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
        • Cadastrar assinante
        • Listar assinantes
        • Detalhe da assinatura
        • Cancelar assinatura
        • Pausar assinatura
        • Reativar assinatura
        • Reenviar cobrança
        • Trocar plano da assinatura
      • Notificações
        • Listar entregas de um webhook
      • Splits
        • Adicionar recebedor de split a um plano
        • Listar splits enviados (perspectiva do seller)
        • Listar convites recebidos (perspectiva do recebedor)
        • Aceitar convite de split
        • Rejeitar convite de split
        • Cancelar split (perspectiva do seller)
      • Produtos — Planos
        • Listar planos aninhados a um produto
        • Criar plano aninhado a um produto
        • Atualizar plano aninhado
        • Desativar plano aninhado
        • Marcar plano como padrão do produto
    • Reembolsos
      • Solicitar reembolso de uma venda
      • Consultar uma solicitação de reembolso
    • Raiz
    • 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
    • Esquemas
      • Webhook
        • CashIn
          • onCreate
          • onUpdate
          • CashinCreated
          • CashinUpdated
          • CashinOld
        • CashOut
          • onCreate
          • onUpdate
        • Cash-In
          • CashinCreated
          • CashinUpdated
          • CashinOld
      • TransactionEvent
      • BillingMethod
      • CardTokenRequest
      • WebhookInput
      • CreditCardCreatePayload
      • CashinCreated
      • CreditCardCreated
      • RefundReason
      • CashoutCreated
      • CreditCardUpdated
      • CreditCardStatusPayload
      • CardToken
      • Transaction
      • CashinUpdated
      • CashoutUpdated
      • Webhook
      • PlanStatus
      • RefundStatus
      • SplitStatus
      • CashinOld
      • RefundWebhookPayload
      • Customer
      • CreatedWebhook
      • CreditCardPaymentRequest
      • RefundRejectionCategory
      • PaymentMethod
      • CreditCardPaymentAccepted
      • DebtorAccount
      • SubscriptionSplit
      • WebhookListItem
      • Payment
      • WebhookDelivery
      • RefundRequest
      • SplitRecipientPayload
      • SimpleError
      • RefundTransaction
      • SubscriptionSplitInvite
      • StoreProductPlanRequest
      • RotatedWebhookSecret
      • Card
      • CodedError
      • RefundEvent
      • SubscriptionStatus
      • Checkout
      • UpdateProductPlanRequest
      • RefusedError
      • ChargeStatus
      • PaymentLink
      • AntiFraudError
      • Error
      • Tracking
      • ValidationError
      • PlanResource
      • PaginationMeta
      • ChargeResource
      • SubscriptionResource
      • EnrollPaymentQrCode
      • EnrollPaymentPixAutomatico
      • WebhookResource
      • NotFoundError
      • WebhookEnvelope
      • ChargeBlock
      • MandateBlock
      • WebhookDeliveryResource

    SubscriptionResource

    Representação pública de uma assinatura de cliente.

    {
        "token": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "status": "pending_first_payment",
        "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.00",
            "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",
            "splits": [
                {
                    "email": "parceiro@empresa.com",
                    "name": "Parceiro Silva",
                    "percentage": 20,
                    "status": "pending",
                    "invited_at": "2026-07-14T18:30:00+00:00",
                    "accepted_at": "2026-07-14T18:45:12+00:00"
                }
            ],
            "is_default": false,
            "display_order": 0,
            "active_subscriptions_count": 12,
            "product": {
                "reference_id": "a245c59c-e269-42ff-b36d-b0a0059768d3",
                "name": "Curso Premium",
                "image_url": "https://cdn.syncpayments.com.br/products/abc.png"
            }
        },
        "charges": [
            {
                "cycle_number": 2,
                "amount": "50.00",
                "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
                }
            }
        ]
    }
    Built with