1. Planos
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
        GET
      • Criar plano
        POST
      • Detalhe do plano
        GET
      • Editar plano
        PATCH
      • Arquivar plano
        DELETE
      • Assinantes do plano
        GET
    • Assinantes
      • Listar assinantes
      • Detalhe da assinatura
      • Cancelar assinatura
      • Pausar assinatura
      • Reativar assinatura
      • Reenviar cobrança
  • Esquemas
    • Webhook
      • CashIn
        • onCreate
        • onUpdate
      • CashOut
        • onCreate
        • onUpdate
    • BillingMethod
    • PlanStatus
    • SubscriptionStatus
    • ChargeStatus
    • PlanResource
    • ChargeResource
    • SubscriptionResource
    • PaginationMeta
    • ValidationError
    • NotFoundError
  1. Planos

Listar planos

GET
/api/partner/v1/subscription-plans
Lista todos os planos do seller autenticado, ordenados do mais recente
para o mais antigo.

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 Consulta

Respostas

🟢200
application/json
Lista paginada de planos.
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/partner/v1/subscription-plans?page=&per_page=&status=' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "data": [
        {
            "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"
        }
    ],
    "meta": {
        "total": 1,
        "current_page": 1,
        "per_page": 15,
        "last_page": 1
    }
}
Modificado em 2026-06-19 15:29:20
Página anterior
Consulta os dados do Parceiro
Próxima página
Criar plano
Built with