Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bitgpt.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Invoice object containing billing information, invoice items, calculations, and organization details for payment processing

id
string
required

Unique identifier for the invoice

Example:

"invoice_0197d634-7d8e-7615-8007-e37b992cdb30"

organization_id
string
required

Unique identifier for the organization

Example:

"org_0196b0e9-11d8-7f26-b1d2-bd47054e4827"

status
enum<string>
required

Current status of the invoice

Available options:
PENDING,
COMPLETED,
VOIDED,
PROCESSING,
WAITING_FOR_CONFIRMATIONS,
PARTIALLY_PAID
Example:

"PENDING"

currency
enum<string>
required

Currency code for the invoice

Available options:
BITCOIN,
ETHEREUM,
USDT,
USDC,
USDC_NATIVE,
SOLANA,
BINANCE_COIN,
RIPPLE,
POLYGON,
TRON,
LITECOIN,
BITCOIN_CASH,
DOGECOIN,
USD,
EUR,
CHF,
GBP,
AUD,
JPY,
CNY,
CAD,
HKD,
SGD,
SEK,
KRW,
NOK,
NZD,
INR,
MXN,
TWD,
ZAR,
BRL,
DKK,
PLN,
THB,
ILS,
IDR,
CZK,
AED,
TRY,
HUF,
CLP,
SAR,
PHP,
MYR,
COP,
RUB,
RON,
PEN
Example:

"EUR"

price
string
required

Total price of the invoice as a decimal string

Example:

"504.818257074815000000000000000000"

created_at
string<mysql-date-time>
required

Timestamp when the invoice was created

Example:

"2025-07-04 18:10:53"

updated_at
string<mysql-date-time> | null
required

Timestamp when the invoice was last updated

Example:

"2025-07-04 18:10:53"

customer_email
string<email>

Customer email address for the invoice

Example:

"customer@example.com"

substatus
enum<string> | null

Provides additional context to the invoice's current status

Available options:
OVERPAID
Example:

"OVERPAID"

price_usd
string

Total price of the invoice in USD as a decimal string

Example:

"504.818257074815000000000000000000"

metadata
object

Additional metadata for the invoice

redirect_url
string<uri> | null

URL to redirect to after payment completion

Example:

"https://example.com/success"

items
object[]

Array of invoice items

calculations
object[]

Array of invoice calculations

calculation_summary
object

Summary of invoice calculations

organization
object

Organization information

payments
object[]

Array of payments