Skip to main content
POST

Corpo da requisição

string
required
BOLETO, CARD_CREDIT ou PIX.
number
required
Valor de cada ciclo em reais.
object
required
Pagador: name, taxId, email e phone opcionais, id opcional.
string
required
WEEKLY, BIWEEKLY, MONTHLY, BIMONTHLY, QUARTERLY, SEMIANNUALLY ou YEARLY.
string
required
Primeiro vencimento (YYYY-MM-DD).
string
Descrição da assinatura.
string
Token do cartão quando method é CARD_CREDIT.
object
Dados do cartão na primeira cobrança (CARD_CREDIT).
object
Titular do cartão (obrigatório com creditCard).
string
IP do comprador (CARD_CREDIT). Se omitido, usa o IP da requisição.
Recorrência com ciclo fixo. Para pagamento único use POST /billings/create. CARD_DEBIT e voucher não são suportados em assinaturas.

Authorizations

X-API-Key
string
header
required

Chave wp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json
method
enum<string>
required
Available options:
BOLETO,
CARD_CREDIT,
PIX
amount
number
required
Required range: x >= 0.01
cycle
enum<string>
required
Available options:
WEEKLY,
BIWEEKLY,
MONTHLY,
BIMONTHLY,
QUARTERLY,
SEMIANNUALLY,
YEARLY
nextDueDate
string<date>
required
customer
object
required
description
string
cardToken
string

Token de cartão (cobranças seguintes)

creditCard
object
creditCardHolderInfo
object
remoteIp
string

IP do comprador (obrigatório em CARD_CREDIT)

authorizeOnly
boolean

Response

Operação concluída.

success
boolean
required
Example:

true

message
string
required
Example:

"Operação concluída com sucesso"

data
object
required
requestId
string