Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

holderId
integer<int64>
required

ID do parceiro

organizationId
integer<int64>
required

ID da organização

Body

application/json

Corpo da requisição

documentType
string

Tipo do documento, somente duas opções válidas: CPF | CNPJ

documentNumber
string

Valor do documento CPF / CNPJ

Response

Resultado do consumo de plano do usuário

success
boolean

Indica se a operação foi bem-sucedida

reason
string

Razão de falha ou código adicional

total
integer

Total de registros encontrados

result
object[]