POST
/
billing
/
create
curl --request POST \
  --url https://api.abacatepay.com/v1/billing/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "frequency": "ONE_TIME",
  "methods": [
    "PIX"
  ],
  "products": [
    {
      "externalId": "prod-1234",
      "name": "Assinatura de Programa Fitness",
      "description": "Acesso ao programa fitness premium por 1 mês.",
      "quantity": 2,
      "price": 2000
    }
  ],
  "returnUrl": "https://example.com/billing",
  "completionUrl": "https://example.com/completion",
  "customerId": "cust_abcdefghij",
  "customer": {
    "name": "Daniel Lima",
    "cellphone": "(11) 4002-8922",
    "email": "daniel_lima@abacatepay.com",
    "taxId": "123.456.789-01"
  }
}'
{
  "data": {
    "id": "bill_123456",
    "url": "https://pay.abacatepay.com/bill-5678",
    "amount": 4000,
    "status": "PENDING",
    "devMode": true,
    "methods": [
      "PIX"
    ],
    "products": [
      {
        "id": "prod_123456",
        "externalId": "prod-1234",
        "quantity": 2
      }
    ],
    "frequency": "ONE_TIME",
    "nextBilling": null,
    "customer": {
      "id": "bill_123456",
      "metadata": {
        "name": "Daniel Lima",
        "cellphone": "(11) 4002-8922",
        "email": "daniel_lima@abacatepay.com",
        "taxId": "123.456.789-01"
      }
    }
  },
  "error": "<any>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
frequency
enum<string>
default:ONE_TIME
required

Define o tipo de frequência da cobrança. Para cobranças únicas, use ONE_TIME. Para cobranças que podem ser pagas mais de uma vez, use MULTIPLE_PAYMENTS.

Available options:
ONE_TIME,
MULTIPLE_PAYMENTS
Example:

"ONE_TIME"

​
methods
enum<string>[]
required

Métodos de pagamento que serão utilizados. Atualmente, apenas PIX é suportado.

Available options:
PIX
Example:
["PIX"]
​
products
object[]
required

Lista de produtos que seu cliente está pagando.

Example:
[
  {
    "externalId": "prod-1234",
    "name": "Assinatura de Programa Fitness",
    "description": "Acesso ao programa fitness premium por 1 mês.",
    "quantity": 2,
    "price": 2000
  }
]
​
returnUrl
string
required

URL para redirecionar o cliente caso o mesmo clique na opção "Voltar".

Example:

"https://example.com/billing"

​
completionUrl
string
required

URL para redirecionar o cliente quando o pagamento for concluído.

Example:

"https://example.com/completion"

​
customerId
string

O id de um cliente já cadastrado em sua loja.

Example:

"cust_abcdefghij"

​
customer
object

Os dados do seu cliente para criá-lo

Response

200
application/json
Cobrança criada com sucesso.
​
data
object
​
error
any