Skip to main content
GET
/
api
/
v1
/
invoices
/
{invoice_id}
{
  "id": "<string>",
  "object": "invoice",
  "subscription_id": "<string>",
  "customer": "<string>",
  "amount_due": 123,
  "amount_paid": 123,
  "amount_remaining": 123,
  "currency": "<string>",
  "status": "open",
  "payment_status": "pending",
  "billing_reason": "<string>",
  "period_start": 123,
  "period_end": 123,
  "created": 123,
  "frequency": "<string>",
  "recurring_interval": "day",
  "recurring_interval_count": 123,
  "payment_id": "<string>",
  "paid_at": 123,
  "due_date": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.stablepayfi.ai/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer API Key, for example Bearer sk_live_xxx.

​
X-StablePay-Timestamp
string
header
required

Unix timestamp in seconds. Must be within 5 minutes of server time.

​
X-StablePay-Nonce
string
header
required

Replay-protection nonce, 16-64 characters. Use a fresh UUID per request.

​
X-StablePay-Signature
string
header
required

Lowercase hex HMAC-SHA256 of {timestamp}.{nonce}.{requestBody} signed with the merchant API Secret. For GET requests, requestBody is an empty string.

Headers

​
X-StablePay-Timestamp
string
required

Unix timestamp in seconds. Must be within 5 minutes of server time.

​
X-StablePay-Nonce
string
required

Replay-protection nonce, 16-64 characters. Use a fresh UUID per request.

Required string length: 16 - 64
​
X-StablePay-Signature
string
required

Lowercase hex HMAC-SHA256 of {timestamp}.{nonce}.{requestBody} signed with the merchant API Secret. For GET requests, requestBody is an empty string.

Path Parameters

​
invoice_id
string
required

Invoice ID.

Response

Retrieved successfully.

​
id
string
required

Invoice ID.

​
object
string
required
Example:

"invoice"

​
subscription_id
string
required

Related subscription ID.

​
customer
string
required

Customer ID.

​
amount_due
integer<int64>
required

Amount due in minor units.

​
amount_paid
integer<int64>
required

Amount paid in minor units.

​
amount_remaining
integer<int64>
required

Amount remaining in minor units.

​
currency
string
required

Currency.

​
status
enum<string>
required

Invoice status. Query values must be lowercase: open, paid, or void.

Available options:
open,
paid,
void
​
payment_status
enum<string>
required

Invoice payment status.

Available options:
pending,
processing,
completed,
failed,
canceled,
expired
​
billing_reason
string
required

Billing reason, for example subscription_create or subscription_cycle.

​
period_start
integer<int64>
required

Billing period start, Unix seconds.

​
period_end
integer<int64>
required

Billing period end, Unix seconds.

​
created
integer<int64>
required

Creation time, Unix seconds.

​
frequency
string

Human-readable billing frequency, for example Monthly.

​
recurring_interval
enum<string>

Recurring interval.

Available options:
day,
week,
month,
year
​
recurring_interval_count
integer<int32>

Recurring interval count.

​
payment_id
string

Related payment session ID. The API prefers payment_session_id and falls back to trade_order_id.

​
paid_at
integer<int64>

Payment completion time, Unix seconds.

​
due_date
integer<int64>

Due date, Unix seconds.

Last modified on April 30, 2026