​
Parameters

​
invoice_id
string
required

The unique identifier (UUID) of the invoice you want to retrieve

​
Response:

​
id
uuid/string

id of the invoice as string, specifically UUID

​
amount
float

Amount of the invoice

​
currency
string

Currency of the invoice

​
fiat_amount_usd
float

The invoice amount in USD

​
created_at
integer

Time of creation of invoice, UNIX timestamp

​
valid_until
integer

Time of when invoice expires, UNIX timestamp

​
title
string

Title of the invoice

​
description
string

Description of the invoice

​
post_paid_text
string

Text that will be shown to user after successful payment

​
receiving_wallet
string

Wallet address where the payment will be received

​
simulated_invoice
boolean

Whether the invoice is simulated (for testing purposes)

​
status
string

Current status of the invoice

​
link
string

Link to checkout page for the invoice

​
custom_data
json

Custom data associated with the invoice

​
Example

from squaredinc_sdk import SquaredSDK

squared = SquaredSDK(
    api_key="your-api-key"
)

invoice = squared.get_invoice(
    "1f574ed3-ba0a-4d2d-9843-7a9b70c0e4d7"
)

print(invoice)

​
Return

Get invoice API will return the invoice object:

{
  "id": "1f574ed3-ba0a-4d2d-9843-7a9b70c0e4d7",
  "amount": 100.00000112,
  "currency": "ton",
  "fiat_amount_usd": 294.1,
  "created_at": 1750279161,
  "valid_until": 1750282761,
  "title": "Test invoice",
  "description": "Test description",
  "post_paid_text": "",
  "receiving_wallet": "12",
  "simulated_invoice": false,
  "status": "pending_payment",
  "link": "https://checkout.squaredinc.co/1f574ed3-ba0a-4d2d-9843-7a9b70c0e4d7",
  "custom_data": {
    "ping": "pong"
  }
}