Skip to main content
POST
Criar uma nova assinatura (Checkout de assinatura)
Cria um checkout de assinatura. O cliente paga uma vez e entra no ciclo de cobranças recorrentes do produto.

Pré-requisito

O produto referenciado em items deve ter um cycle definido (WEEKLY, MONTHLY, SEMIANNUALLY ou ANNUALLY). Produtos avulsos retornam erro.
Exemplo:
Redirecione o cliente para data.url para concluir o primeiro pagamento e ativar a assinatura.
Assinaturas aceitam apenas um produto por checkout. O método padrão é CARD.
Se o produto referenciado tiver trialDays configurado, o checkout cobra R$ 0,00 — apenas tokeniza o cartão. A primeira cobrança pelo valor integral ocorre automaticamente ao final do trial. Consulte a referência de assinaturas para mais detalhes.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json

Mesmos parâmetros do Checkout, com items contendo exatamente um item (id e quantity). O produto referenciado deve ter sido criado com ciclo de assinatura (frequency) na loja.

items
object[]
required

Lista com exatamente um item. O produto deve ter sido criado com ciclo de assinatura (frequency). O valor total é calculado a partir do produto.

Required array length: 1 element
methods
enum<string>[]

Métodos de pagamento disponíveis. Assinaturas suportam apenas CARD. Padrão ["CARD"].

Minimum array length: 1
Available options:
PIX,
CARD
returnUrl
string<uri>

URL para onde o cliente será redirecionado ao clicar em "Voltar" no checkout.

completionUrl
string<uri>

URL para onde o cliente será redirecionado após o pagamento ser concluído.

customerId
string

ID de um cliente já cadastrado na sua loja. Se informado, o checkout será pré-preenchido com os dados deste cliente.

coupons
string[]

Lista de cupons que podem ser utilizados nesta cobrança.

Maximum array length: 50
externalId
string

ID da assinatura no seu sistema, caso queira manter uma referência própria.

metadata
object

Metadados adicionais. Campo livre para a sua aplicação.

Response

Checkout de assinatura criado com sucesso. Use a url retornada para redirecionar o cliente.

data
object
error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true