Pular para o conteúdo principal
POST
Inscrever cliente no produto

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Cabeçalhos

Idempotency-Key
string

Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.

Parâmetros de caminho

productID
string
obrigatório

ID do produto.

Pattern: ^prod_[0-9A-Za-z]{22}$
Exemplo:

"prod_1d4YogBuw00jAySh5mbUpk"

Corpo

application/json
externalId
string
obrigatório

O id deste cliente no seu sistema (por exemplo, o id do usuário no seu app). Obrigatório; repetir o mesmo valor devolve o mesmo cliente.

name
string | null

Nome do cliente.

email
string<email> | null

E-mail do cliente.

phone
string | null
taxId
string | null

CPF ou CNPJ.

country
string | null

País do cliente, em código ISO de duas letras (BR, US). Hoje a venda é no Brasil; venda internacional está em breve.

Exemplo:

"BR"

pspRef
string | null

Referência do cliente no meio de pagamento, se você já tiver uma. Normalmente não é preciso enviar.

metadata
object

Dados livres seus, em JSON. Guardados na inscrição.

Resposta

Inscrição criada ou já existente.

Uma inscrição: este cliente neste produto. O id é o id da inscrição, que assinaturas, faturas, uso e créditos referenciam.

id
string<uuid>
obrigatório

Id da inscrição. É este que as chamadas de cobrança e de uso esperam.

customerId
string
obrigatório

Id do cliente. Não use nas chamadas de cobrança e de uso; use id.

Pattern: ^cus_[0-9A-Za-z]{22}$
Exemplo:

"cus_6Tq0Y2rGJ1aQ9zXk3LmPbV"

productId
string
obrigatório
Pattern: ^prod_[0-9A-Za-z]{22}$
Exemplo:

"prod_1d4YogBuw00jAySh5mbUpk"

externalId
string
obrigatório

O id do cliente no seu sistema.

metadata
object
obrigatório

Os dados livres enviados na inscrição.

creditAlertSent
boolean
obrigatório

Se o aviso de créditos baixos já foi enviado para esta inscrição.

createdAt
string<date-time>
obrigatório
name
string | null
email
string | null
taxId
string | null

CPF ou CNPJ.

pspRef
string | null

Referência do cliente no meio de pagamento, quando existe.