Pular para o conteúdo principal
POST
/
workspaces
/
{workspaceId}
/
billing-accounts
/
{billingAccountId}
/
invoices
/
preview
Pré-visualizar uma fatura
curl --request POST \
  --url https://api.altostrat.io/workspaces/{workspaceId}/billing-accounts/{billingAccountId}/invoices/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "subscription_id": "sub_a1b2c3d4e5f6g7h8",
  "items": [
    {
      "product_type": "locations",
      "quantity": 15,
      "interval": "month"
    }
  ],
  "cancel_subscription": false
}'
{
  "id": "in_1Kb...",
  "customer_id": "cus_...",
  "status": "paid",
  "amount_due": 999,
  "amount_paid": 999,
  "currency": "usd",
  "created_at": "2025-10-29T00:40:06.000000Z",
  "subtotal": 1099,
  "total": 999,
  "tax": 0,
  "discount_amount": 100,
  "discount_names": [
    "Cupom de 10% de Desconto"
  ],
  "lines": [
    {
      "id": "il_1Kb...",
      "description": "10 × Locais",
      "amount": 1000,
      "currency": "usd",
      "quantity": 10,
      "price_id": "price_...",
      "unit_amount": 100,
      "product_name": "Locais"
    }
  ],
  "due_date": null,
  "hosted_invoice_url": "https://invoice.stripe.com/...",
  "invoice_pdf": "https://pay.stripe.com/...",
  "number": "AB123-001"
}

Authorizations

​
Authorization
string
header
required

Insira seu JWT no formato: Bearer {token}

Path Parameters

​
workspaceId
string
required

O ID do workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

​
billingAccountId
string
required

O ID da conta de faturamento, que corresponde a um ID de Cliente do Stripe (cus_...).

Example:

"cus_a1b2c3d4e5f6g7h8"

Body

application/json
​
subscription_id
string

O ID de uma assinatura existente para pré-visualizar alterações. Se omitido, pré-visualiza uma nova assinatura.

Example:

"sub_a1b2c3d4e5f6g7h8"

​
items
object[]

Uma lista de produtos e suas novas quantidades para pré-visualizar. Para remover um produto, defina sua quantidade como 0 ou omita-o.

​
cancel_subscription
boolean

Defina como true para pré-visualizar a fatura para cancelar a assinatura no final do período atual.

Example:

false

Response

O objeto da fatura pré-visualizada.

​
id
string
Example:

"in_1Kb..."

​
customer_id
string
Example:

"cus_..."

​
status
string
Example:

"paid"

​
amount_due
integer

Valor final devido na menor unidade monetária (ex centavos).

Example:

999

​
amount_paid
integer

O valor pago nesta fatura na menor unidade monetária.

Example:

999

​
currency
string
Example:

"usd"

​
created_at
string<date-time>
Example:

"2025-10-29T00:40:06.000000Z"

​
subtotal
integer

Total de todos os itens de linha antes de descontos e impostos.

Example:

1099

​
total
integer

Total após descontos e impostos.

Example:

999

​
tax
integer | null

O valor do imposto nesta fatura.

Example:

0

​
discount_amount
integer | null

O valor total do desconto aplicado a esta fatura.

Example:

100

​
discount_names
string[]
Example:
["Cupom de 10% de Desconto"]
​
lines
object[]
​
due_date
string<date-time> | null
Example:

null

​
hosted_invoice_url
string<uri> | null
Example:

"https://invoice.stripe.com/..."

​
invoice_pdf
string<uri> | null
Example:

"https://pay.stripe.com/..."

​
number
string | null
Example:

"AB123-001"