Endpoints da API Venda Recorrente

Guia Completo para Descrição e Resumo

---

Clientes (Customers)

• GET /v1/customers

  • Descrição: Retorna uma lista de clientes.

• POST /v1/customers

  • Descrição: Cadastra um novo cliente.

• GET /v1/customers/{id}

  • Descrição: Retorna um cliente específico pelo ID.

• PUT /v1/customers/{id}

  • Descrição: Atualiza um cliente existente pelo ID.

• DELETE /v1/customers/{id}

  • Descrição: Arquiva um cliente específico pelo ID.

• POST /v1/customers/{id}/unarchive

  • Descrição: Reverte o arquivamento de um cliente.

  ---

  
  

Planos (Plans)

• GET /v1/plans

  • Descrição: Retorna uma lista de planos.

• POST /v1/plans

  • Descrição: Cadastra um novo plano.

• GET /v1/plans/{id}

  • Descrição: Retorna um plano específico pelo ID.

• PUT /v1/plans/{id}

  • Descrição: Atualiza um plano existente pelo ID.

• GET /v1/plans/{id}/plan_items

  • Descrição: Retorna os itens do plano pelo ID.

  ---

  
  

Produtos (Products)

• GET /v1/products

  • Descrição: Retorna uma lista de produtos.

• POST /v1/products

  • Descrição: Cadastra um novo produto.

• GET /v1/products/{id}

  • Descrição: Retorna um produto específico pelo ID.`

• PUT /v1/products/{id}

  • Descrição: Atualiza um produto existente pelo ID.

Métodos de Pagamento (Payment Methods)

• GET /v1/payment_methods

  • Descrição: Lista todos os métodos de pagamento disponíveis.

• GET /v1/payment_methods/{id}

  • Descrição: Retorna um método de pagamento específico pelo ID.

Descontos (Discounts)

• POST /v1/discounts

  • Descrição: Cria um desconto em uma assinatura existente.

• GET /v1/discounts/{id}

  • Descrição: Retorna um desconto específico pelo ID.

• DELETE /v1/discounts/{id}

  • Descrição: Cancela um desconto pelo ID.

  ---

  
  

Assinaturas (Subscriptions)

• GET /v1/subscriptions

  • Descrição: Retorna uma lista de assinaturas.

• POST /v1/subscriptions

  • Descrição: Cria uma nova assinatura.

• GET /v1/subscriptions/{id}

  • Descrição: Retorna uma assinatura específica pelo ID.

• PUT /v1/subscriptions/{id}

  • Descrição: Atualiza uma assinatura existente pelo ID.`

• DELETE /v1/subscriptions/{id}

  • Descrição: Cancela uma assinatura pelo ID.

• POST /v1/subscriptions/{id}/reactivate

  • Descrição: Reativa uma assinatura cancelada pelo ID.

• POST /v1/subscriptions/{id}/renew

  • Descrição: Renova uma assinatura existente.

• GET /v1/subscriptions/{id}/product_items

  • Descrição: Retorna os itens de uma assinatura pelo ID.`

Itens de Assinatura (Product Items)

• POST /v1/product_items

  • Descrição: Cadastra um novo item em uma assinatura existente.

• GET /v1/product_items/{id}

  • Descrição: Retorna um item de assinatura específico pelo ID.

• PUT /v1/product_items/{id}

  • Descrição: Atualiza um item existente.

• DELETE /v1/product_items/{id}

  • Descrição: Remove um item pelo ID.

Faturas (Bills)

• GET /v1/bills

  • Descrição: Retorna uma lista de faturas.

• GET /v1/bills/{id}

  • Descrição: Retorna uma fatura específica pelo ID.

Períodos (Periods)

• GET /v1/periods/{id}

  • Descrição: Retorna um período específico pelo ID.

• PUT /v1/periods/{id}

  • Descrição: Atualiza um período existente.

Cobranças (Charges)

• GET /v1/charges
  • Descrição: Retorna uma lista de cobranças.
• POST /v1/charges
  • Descrição: Cria uma nova cobrança.`
• GET /v1/charges/{id}
  • Descrição: Retorna uma cobrança específica pelo ID.
• PUT /v1/charges/{id}
  • Descrição: Atualiza uma cobrança existente pelo ID.
• DELETE /v1/charges/{id}
  • Descrição: Cancela uma cobrança pelo ID.

Itens de Fatura (Bill Items)

• POST /v1/bill_items

  • Descrição: Cria um novo item de fatura.

• GET /v1/bill_items/{id}

  • Descrição: Retorna um item de fatura específico pelo ID.

• PUT /v1/bill_items/{id}

  • Descrição: Atualiza um item de fatura existente.

• DELETE /v1/bill_items/{id}

  • Descrição: Remove um item de fatura pelo ID.`

Usos (Usages)

• GET /v1/usages

  • Descrição: Retorna uma lista de usos.

• POST /v1/usages

  • Descrição: Cria um novo uso.`

• GET /v1/usages/{id}

  • Descrição: Retorna um uso específico pelo ID.

• PUT /v1/usages/{id}

  • Descrição: Atualiza um uso existente pelo ID.

• DELETE /v1/usages/{id}

  • Descrição: Remove um uso pelo ID.

Faturas (Invoices)

• GET /v1/invoices

  • Descrição: Retorna uma lista de faturas.

• POST /v1/invoices

  • Descrição: Cria uma nova fatura.`

• GET /v1/invoices/{id}

  • Descrição: Retorna uma fatura específica pelo ID.`

• PUT /v1/invoices/{id}

  • Descrição: Atualiza uma fatura existente.

• DELETE /v1/invoices/{id}

  • Descrição: Remove uma fatura pelo ID.

Movimentos (Movements)

• GET /v1/movements

  • Descrição: Retorna uma lista de movimentos.

• POST /v1/movements

  • Descrição: Cria um novo movimento.

• GET /v1/movements/{id}

  • Descrição: Retorna um movimento específico pelo ID.

Mensagens (Messages)

• GET /v1/messages
  • Descrição: Retorna uma lista de mensagens.

Lotes de Exportação (Export Batches)

• GET /v1/export_batches

  • Descrição: Retorna uma lista de lotes de exportação.`

• POST /v1/export_batches

  • Descrição: Cria um novo lote de exportação.`

• GET /v1/export_batches/{id}

  • Descrição: Retorna um lote de exportação específico pelo ID.`

Lotes de Importação (Import Batches)

• GET /v1/import_batches

  • Descrição: Retorna uma lista de lotes de importação.

• POST /v1/import_batches

  • Descrição: Cria um novo lote de importação.

• GET /v1/import_batches/{id}

  • Descrição: Retorna um lote de importação específico pelo ID.`

Problemas (Issues)

• GET /v1/issues
  • Descrição: Retorna uma lista de problemas.

Notificações (Notifications)

• GET /v1/notifications
  • Descrição: Retorna uma lista de notificações.

Comerciantes (Merchants)

• GET /v1/merchants

  • Descrição: Retorna uma lista de comerciantes.

• POST /v1/merchants

  • Descrição: Cria um novo comerciante.`

• GET /v1/merchants/{id}

  • Descrição: Retorna um comerciante específico pelo ID.

Usuários de Comerciante (Merchant Users)

• GET /v1/merchant_users

  • Descrição: Retorna uma lista de usuários de comerciante.

• POST /v1/merchant_users

  • Descrição: Cria um novo usuário de comerciante.

• GET /v1/merchant_users/{id}

  • Descrição: Retorna um usuário de comerciante específico pelo ID.