Pular para o conteúdo

Faturas

Uma fatura é um documento de cobrança do lojista — numerado, detalhado por item e endereçado a um cliente — que é pago por meio da sua própria intenção de pagamento e do seu checkout hospedado.

POST/v1/invoiceslive · após ativação da conta
{
"store_id": "store_01J…",
"currency": "EUR",
"items": [
{ "description": "Annual plan", "quantity": 1, "unit_amount": "480.00" },
{ "description": "Onboarding session", "quantity": 2, "unit_amount": "60.00" }
],
"customer": { "name": "Ada Example", "email": "ada@example.com", "reference": "cust-42" },
"memo": "Thank you for your order.",
"expires_in_seconds": 604800
}
  • Os valores das linhas e o total são calculados pela API a partir de quantity × unit_amount; você nunca envia um total que possa divergir.
  • Os números das faturas são sequenciais por organização e ambiente.
  • A resposta inclui payment_intent_id, payment_status e a checkout_url para enviar ao cliente.

O status da fatura é derivado da sua intenção de pagamento:

Status da fatura Intenção de pagamento
open aguardando pagamento ou em andamento
paid confirmed / overpaid, ou resolvida como aceita
partially_paid underpaid
review late_payment, manual_review ou reorged
expired expired sem pagamento
void anulada por você

POST /v1/invoices/{id}/void anula uma fatura e cancela a sua intenção de pagamento, mas apenas antes de qualquer transferência ter sido observada.