Skip to main content
GET
Get invoice

Authorizations

Authorization
string
header
required

Store-scoped API key. Prefix with sk_live_. Example: Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE

Path Parameters

id
string
required

Invoice ID from create or list responses (starts with inv_).

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$

Response

Invoice details

Full invoice record returned by list and get endpoints.

id
string

Unique invoice ID (inv_...).

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$
external_order_id
string

Your order reference from when the invoice was created.

Example:

"order_demo_1048"

status
enum<string>

Where the invoice is in the payment flow:

  • pending: created, not yet ready for payment
  • quoted: price quote ready; customer can proceed to pay
  • awaiting_payment: waiting for the customer to send funds
  • paid: payment received and confirmed
  • underpaid: customer paid less than the requested amount
  • expired: not paid before the deadline
  • failed: payment or processing failed
  • refunded: payment was returned to the customer
  • cancelled: invoice was cancelled before completion
Available options:
pending,
quoted,
awaiting_payment,
paid,
underpaid,
expired,
failed,
refunded,
cancelled
amount
string

Amount you requested to receive (decimal string, e.g. "100.00").

Example:

"100.00"

currency
string

Currency of amount (e.g. USD).

Example:

"USD"

order_amount
string

Original order total before conversion, if different from amount.

Example:

"100.00"

order_currency
string

Currency of order_amount.

Example:

"USD"

paid_amount
string | null

How much the customer actually paid. null until payment starts.

Example:

"100.00"

output_asset
string

Stablecoin paid out to you (e.g. USDC).

Example:

"USDC"

checkout_url
string<uri> | null

Payment page URL while the invoice can still be paid. null if no longer payable.

return_url
string<uri> | null

Where the customer is redirected after checkout, if you set one at creation.

customer_id
string<uuid> | null

Internal customer record ID, if linked. Usually not needed for basic integrations.

Pay Link that created this invoice, if applicable.

transaction_hash
string | null

Blockchain transaction ID after payment is confirmed. null until paid.

metadata
object | null

Custom data you attached when creating the invoice.

created_at
string<date-time>

When the invoice was created (UTC).

updated_at
string<date-time>

When the invoice was last updated (UTC).

paid_at
string<date-time> | null

When payment was confirmed. null until the invoice is paid.

expires_at
string<date-time>

Deadline to pay before the invoice expires (UTC).