Criar uma Sessão de Checkout
curl --request POST \
--url https://api.billing.upag.io/v1/checkout-sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{}]})
};
fetch('https://api.billing.upag.io/v1/checkout-sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.billing.upag.io/v1/checkout-sessions';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{}]})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Sessões de Checkout
Criar uma Sessão de Checkout
Crie uma nova sessão de checkout para um cliente
POST
https://api.billing.upag.io
/
v1
/
checkout-sessions
Criar uma Sessão de Checkout
curl --request POST \
--url https://api.billing.upag.io/v1/checkout-sessions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{}]})
};
fetch('https://api.billing.upag.io/v1/checkout-sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://api.billing.upag.io/v1/checkout-sessions';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({items: [{}]})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));Cria uma nova sessão de checkout com pelo menos um item (preço + quantidade). Retorna a URL da página de pagamento para redirecionar o cliente.
Endpoint
cURL
curl -X POST https://api.billing.upag.io/v1/checkout-sessions \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-d '{
"customerId": "cus_ahwDXrgYvur89iPs",
"items": [
{
"priceId": "price_def456ghi",
"quantity": 1
}
],
"paymentMethods": ["credit_card", "pix"],
"billingAddressCollection": "auto",
"successUrl": "https://seusite.com/sucesso",
"cancelUrl": "https://seusite.com/cancelado"
}'
Parâmetros
array
required
Lista de linhas do checkout. Cada item precisa de
priceId (string) e quantity (número, mínimo 1). É obrigatório pelo menos um item.string
Opcional. ID do cliente (
cus_...) para associar à sessão.string[]
Opcional. Métodos aceitos na sessão. Valores do enum da API:
credit_card, pix.string
Opcional. Um de:
auto, required, none.string
Opcional. URL válida para redirecionar após pagamento bem-sucedido.
string
Opcional. URL válida se o cliente cancelar o fluxo.
Resposta
Response
{
"id": "cs_abc123xyz",
"status": "open",
"customerId": "cus_ahwDXrgYvur89iPs",
"url": "https://checkout.upag.io/cs_abc123xyz",
"billingAddressCollection": false,
"successUrl": "https://example.com/success",
"cancelUrl": "https://example.com/cancel",
"latitude": null,
"longitude": null,
"country": null,
"region": null,
"city": null,
"expiresAt": "2024-11-16T10:00:00.000Z",
"createdAt": "2024-11-15T10:00:00.000Z",
"updatedAt": "2024-11-15T10:00:00.000Z",
"items": []
}