Gerenciamento de Keys
Adicionando Creditos

Adicionando créditos para uma Publishable Key

Cada publishable key tem uma quantidade limitada de créditos que podem ser adicionados ou removidos.

Quando uma key é criada, por padrão, ela vem sem crédito nenhum, para adicionar ou remover créditos deve fazer uma requisição como a do seguinte exemplo:

axios.post(
  baseUrl + "/admin/customer/",
  {
    creditType: string; // Tipo do crédito a ser concedido ou removido
    amount: number; // Quantidade de créditos a serem concedidos ou removidos. Para remover o valor deverá ser negativo.
    details: string; // Detalhes do motivo da concessão ou remoção do crédito.
    customerId: string;, // O identificador unico do usuário que vai receber ou perder os créditos.
  },
  {
    headers: {
      Authorization: "Bearer " + masterApiKey,
    },
  },
);

O parâmetro creditType é o tipo de crédito a ser removido ou adicionado do usuário, os tipos de crédito são os seguintes:

const CreditType = {
  CREDIT_ALL = "credit-all", // Este tipo de crédito permite ao usuário utilizar qualquer funcionalidade.
  CREDIT_SIMPLE_DRAFT = "credit-simple-draft", // Este tipo de crédito permite ao usuário utilizar em petições iniciais e parecer jurídico.
  CREDIT_COMPLEX_DRAFT = "credit-complex-draft", // Este tipo de crédito permite ao usuário utilizar todas as outras peças, exceto o parecer contratual, e usar análise de PDF's.
  CREDIT_ANALYSIS_OPINION = "credit-analysis-opinion", // Este tipo de crédito permite o usuário utilizar a funcionalidade de Análise Contratual com parecer.
}

O parâmetro amount é valor a ser adicionado ou removido dos créditos do usuário. Este valor pode ser positivo ou negativo.

O parâmetro details é a descrição do motivo de adição ou remoção de créditos, exemplo: "Adicionado crédito por renovação de assinatura".

O parâmetro customerId é o identificador único do usuário.