Criar Checkout de assinatura

Cria um Checkout de assinatura — uma página de pagamento igual ao Checkout comum, mas para cobrança recorrente.

Aceita os mesmos parâmetros do Checkout (returnUrl, completionUrl, customerId, externalId, metadata, coupons, methods). O Checkout de assinatura aceita apenas um produto; o ciclo (frequência) já deve estar definido no produto ao criá-lo na loja — não é enviado no checkout.

POST /subscriptions/create

Criar uma nova assinatura (Checkout de assinatura)

cURL

curl --request POST \
  --url https://api.abacatepay.com/v2/subscriptions/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "id": "prod-1234",
      "quantity": 1
    }
  ],
  "customerId": "cust_abc123xyz",
  "methods": [
    "CARD"
  ]
}
'

200

{
  "data": {
    "id": "bill_abc123xyz",
    "externalId": "pedido-123",
    "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
    "amount": 10000,
    "paidAmount": null,
    "items": [
      {
        "id": "prod_456",
        "quantity": 2
      }
    ],
    "status": "PENDING",
    "coupons": [],
    "devMode": false,
    "customerId": null,
    "returnUrl": null,
    "completionUrl": null,
    "receiptUrl": null,
    "upSellProductId": "prod_bump456xyz",
    "interest": {
      "value": 100
    },
    "fine": {
      "value": 200,
      "type": "PERCENTAGE"
    },
    "metadata": {},
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z"
  },
  "error": null,
  "success": true
}

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:

{
  "items": [
    { "id": "prod_abc123xyz", "quantity": 1 }
  ],
  "customerId": "cust_abc123xyz",
  "externalId": "subs-123",
  "completionUrl": "https://seusite.com/sucesso",
  "methods": ["CARD"]
}

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.

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

Show child attributes

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

200

application/json

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

data · object

Show child attributes

error · string | null

Example:

null

success · boolean

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

Example:

true