Assinaturas de serviço

Base: https://api.nivesistemas.com.br · 6 endpoints

GET /service-subscriptions

Listar assinatura de serviço

curl -X GET "https://api.nivesistemas.com.br/service-subscriptions" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-subscriptions", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/service-subscriptions",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /service-subscriptions

Criar assinatura de serviço

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`customerId`	uuid	sim	Cliente
`contractId`	uuid	não	Contrato vinculado
`name`	string	sim	Nome
`description`	string	não	Descrição
`amount`	number	sim	Valor recorrente
`period`	string	não	Periodicidade
`nextDueDate`	string	sim	Próximo vencimento
`paymentMethodId`	uuid	não	Forma de pagamento
`status`	string	não	Status

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/service-subscriptions" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"00000000-0000-0000-0000-000000000000","contractId":"00000000-0000-0000-0000-000000000000","name":"Exemplo","description":"","amount":0,"period":"","nextDueDate":"","paymentMethodId":"00000000-0000-0000-0000-000000000000","status":""}'

const res = await fetch("https://api.nivesistemas.com.br/service-subscriptions", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customerId": "00000000-0000-0000-0000-000000000000",
    "contractId": "00000000-0000-0000-0000-000000000000",
    "name": "Exemplo",
    "description": "",
    "amount": 0,
    "period": "",
    "nextDueDate": "",
    "paymentMethodId": "00000000-0000-0000-0000-000000000000",
    "status": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/service-subscriptions",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "customerId": "00000000-0000-0000-0000-000000000000",
      "contractId": "00000000-0000-0000-0000-000000000000",
      "name": "Exemplo",
      "description": "",
      "amount": 0,
      "period": "",
      "nextDueDate": "",
      "paymentMethodId": "00000000-0000-0000-0000-000000000000",
      "status": ""
    },
)
print(res.json())

PATCH /service-subscriptions/:id

Atualizar assinatura de serviço

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`customerId`	uuid	sim	Cliente
`contractId`	uuid	não	Contrato vinculado
`name`	string	sim	Nome
`description`	string	não	Descrição
`amount`	number	sim	Valor recorrente
`period`	string	não	Periodicidade
`nextDueDate`	string	sim	Próximo vencimento
`paymentMethodId`	uuid	não	Forma de pagamento
`status`	string	não	Status

curl -X PATCH "https://api.nivesistemas.com.br/service-subscriptions/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"00000000-0000-0000-0000-000000000000","contractId":"00000000-0000-0000-0000-000000000000","name":"Exemplo","description":"","amount":0,"period":"","nextDueDate":"","paymentMethodId":"00000000-0000-0000-0000-000000000000","status":""}'

const res = await fetch("https://api.nivesistemas.com.br/service-subscriptions/{id}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customerId": "00000000-0000-0000-0000-000000000000",
    "contractId": "00000000-0000-0000-0000-000000000000",
    "name": "Exemplo",
    "description": "",
    "amount": 0,
    "period": "",
    "nextDueDate": "",
    "paymentMethodId": "00000000-0000-0000-0000-000000000000",
    "status": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/service-subscriptions/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "customerId": "00000000-0000-0000-0000-000000000000",
      "contractId": "00000000-0000-0000-0000-000000000000",
      "name": "Exemplo",
      "description": "",
      "amount": 0,
      "period": "",
      "nextDueDate": "",
      "paymentMethodId": "00000000-0000-0000-0000-000000000000",
      "status": ""
    },
)
print(res.json())

DELETE /service-subscriptions/:id

Excluir assinatura de serviço

Parâmetros de rota: id

Resposta: 204 No Content

curl -X DELETE "https://api.nivesistemas.com.br/service-subscriptions/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-subscriptions/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/service-subscriptions/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /service-subscriptions/:id

Detalhe da assinatura

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/service-subscriptions/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-subscriptions/{id}", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/service-subscriptions/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /service-subscriptions/generate-receivables

Gerar contas a receber vencidas das assinaturas

curl -X POST "https://api.nivesistemas.com.br/service-subscriptions/generate-receivables" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/service-subscriptions/generate-receivables", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/service-subscriptions/generate-receivables",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())