Gestão de Assinatura

🚧

As informações dos endpoint nos exemplos usados nos fluxos de operações não representam a totalidade de métodos e parâmetros disponiveis.

🔎 Para saber mais detalhes consulte nossa Referencia de API

❗️

Erros

Consulte o response de cada endpoint em Rerefencia de API

Cria uma nova assinatura para um cliente

Método	Endpoint	Mais detalhes do Endpoint
POST	/subscriptions	https://portal-dev-vindi.readme.io/reference/postv1subscriptions

Exemplo de parâmetros

JSON

{
  "customer_id": "123456",
  "plan_id": "7890",
  "payment_method": "credit_card",
  "card_number": "1234567812345678",
  "expiration_month": "12",
  "expiration_year": "2025",
  "holder_name": "João da Silva",
  "security_code": "123"
}

---

Consulta uma assinatura específica pelo ID

Método	Endpoint	Mais detalhes do Endpoint
GET	/subscriptions/{subscription_id}	https://portal-dev-vindi.readme.io/reference/postv1subscriptions

Exemplo de parâmetros

JSON

{
  "subscription_id": "456789"
}

---

Atualiza os detalhes de uma assinatura existente

Método	Endpoint	Mais detalhes do Endpoint
PUT	/subscriptions/{subscription_id}	https://portal-dev-vindi.readme.io/reference/postv1subscriptions

Exemplo de parâmetros

JSON

{
  "plan_id": "9012"
}