Skip to main content
POST

Authorizations

​
Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Path Parameters

​
subscription_id
string
required

ID único da assinatura a ser finalizada, no formato TypeID com prefixo sub_.

Pattern: ^sub_[0-9a-z]{26}$
Example:

"sub_01h455vb4pex5vsknk084sn02s"

Body

application/json

Dados do método de pagamento para finalizar o checkout.

O campo payment_method_type determina qual método de pagamento será utilizado.

Para payment_method_type: card: requer os objetos card e billing_details, e aceita installments dentro do limite configurado no preço. Para payment_method_type: pix: não requer campos adicionais e sempre usa installments: 1.

Dados para finalizar o checkout de uma assinatura.

O campo payment_method_type determina o método de pagamento a ser utilizado.

Tipos suportados:

  • card: Cartão de crédito - requer card e billing_details
  • pix: Pagamento via PIX - não requer campos adicionais
​
payment_method_type
enum<string>
required

Tipo de método de pagamento a ser utilizado.

Valores suportados:

  • card: Cartão de crédito
  • pix: Pagamento instantâneo via PIX (QR Code)
Available options:
card,
pix
Example:

"card"

​
installments
integer
default:1

Quantidade de parcelas para cobrança no cartão de crédito.

Use apenas quando payment_method_type for card e dentro do limite permitido pelo preço da assinatura. Para pix, o backend sempre considera 1.

Required range: 1 <= x <= 12
Example:

3

​
card
object

Dados do cartão de crédito para processamento do pagamento.

Segurança: Os dados do cartão são tokenizados e nunca armazenados em texto claro. Apenas os últimos 4 dígitos e a bandeira são mantidos para referência.

​
billing_details
object

Informações do titular do cartão para validação e prevenção de fraude.

O nome e documento são obrigatórios. O endereço é opcional mas recomendado para aumentar a taxa de aprovação das transações.

Response

Checkout realizado com sucesso.

O response inclui os detalhes da assinatura e do método de pagamento.

Para cartão: A cobrança é processada imediatamente e a assinatura passa para active. Para PIX: O QR code é retornado para o cliente pagar; a assinatura permanece pending até a confirmação do pagamento.

Resposta do checkout bem-sucedido contendo a assinatura e os detalhes do método de pagamento gerado.

​
id
string
required

ID único da assinatura, no formato TypeID com prefixo sub_.

Pattern: ^sub_[0-9a-z]{26}$
Example:

"sub_01h455vb4pex5vsknk084sn02s"

​
object
enum<string>
required

Tipo do objeto retornado. Sempre "subscription".

Available options:
subscription
Example:

"subscription"

​
live_mode
boolean
required

Indica se a requisição foi feita em modo produção.

Example:

true

​
created
integer<int64>
required

Timestamp Unix de quando a assinatura foi criada.

Example:

1764040287

​
customer
string
required

ID do cliente associado à assinatura, no formato TypeID com prefixo cus_.

Pattern: ^cus_[0-9a-z]{26}$
Example:

"cus_01h455vb4pex5vsknk084sn02p"

​
status
enum<string>
required

Status atual da assinatura após o checkout.

  • card: a cobrança é processada imediatamente e o status passa para active.
  • pix: o QR code é gerado, mas o pagamento ainda não foi confirmado; o status permanece pending até a confirmação via webhook.
Available options:
pending,
active,
inactive,
suspended
Example:

"active"

​
current_period_end
integer<int64>

Timestamp Unix do fim do período atual de cobrança.

Example:

1766632287

​
current_period_start
integer<int64>

Timestamp Unix do início do período atual de cobrança.

Example:

1764040287

​
payment_method
object

Detalhes do método de pagamento criado e associado à assinatura.

Para cartão: por segurança, apenas os últimos 4 dígitos são retornados. Para PIX: retorna o QR code, código copia-e-cola e data de expiração.