Skip to main content
POST
Create a payment link

Authorizations

X-API-Key
string
header
required

Company API key. Send in the X-API-Key header.

Headers

x-client-id
string
required

Client identifier for the company in the request.

Example:

"client_abc123"

Body

application/json
title
string
required
Maximum string length: 255
Example:

"Curso Premium"

type
enum<string>
required

Imutável depois de criado.

Available options:
one_time,
subscription
description
string | null
amount
integer | null

Centavos. Obrigatório em one_time, proibido em subscription.

Required range: x >= 1
plan_uuid
string<uuid> | null

Obrigatório em subscription, proibido em one_time.

currency
string
Required string length: 3
Example:

"BRL"

payment_method
enum<string> | null

Omitir aceita ambos. Forçado para card em assinaturas.

Available options:
card,
pix
items
object[] | null
slug
string | null

Único por empresa. Habilita a URL legível do checkout.

Required string length: 3 - 100
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
success_url
string<uri> | null

Apenas https; não pode apontar para localhost, .local ou IPs privados.

Maximum string length: 2048
cancel_url
string<uri> | null
Maximum string length: 2048
is_active
boolean
expires_at
string<date-time> | null

Precisa ser futura. Sem valor = nunca expira.

Response

Link criado

token
string
Example:

"pl_live_a1b2c3d4e5f6"

slug
string | null
Example:

"curso-premium"

title
string
Example:

"Curso Premium"

description
string | null
type
enum<string>
Available options:
one_time,
subscription
amount
integer | null

Centavos. Nulo em links de assinatura.

Example:

29900

currency
string
Example:

"BRL"

payment_method
enum<string> | null

Nulo aceita cartão e PIX.

Available options:
card,
pix
plan_id
integer | null
plan_uuid
string<uuid> | null
items
object[] | null
success_url
string<uri> | null
cancel_url
string<uri> | null
is_active
boolean
Example:

true

expires_at
string<date-time> | null
checkout_url
string<uri>
Example:

"https://checkout.plugtopay.com/minha-empresa/curso-premium"

created_at
string<date-time>