跳转到主要内容
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.

授权

Authorization
string
header
必填

Bearer API Key,例如 Bearer sk_live_xxx

X-StablePay-Timestamp
string
header
必填

Unix 时间戳(秒)。必须与服务端时间相差不超过 5 分钟。

X-StablePay-Nonce
string
header
必填

防重放随机字符串,长度 16-64 个字符,建议每次请求使用新的 UUID。

X-StablePay-Signature
string
header
必填

使用商户 API Secret 对 {timestamp}.{nonce}.{requestBody} 计算 HMAC-SHA256,结果为小写 hex。GET 请求的 requestBody 为空字符串。

请求头

X-StablePay-Timestamp
string
必填

Unix 时间戳(秒)。必须与服务端时间相差不超过 5 分钟。

X-StablePay-Nonce
string
必填

防重放随机字符串,长度 16-64 个字符,建议每次请求使用新的 UUID。

Required string length: 16 - 64
X-StablePay-Signature
string
必填

使用商户 API Secret 对 {timestamp}.{nonce}.{requestBody} 计算 HMAC-SHA256,结果为小写 hex。GET 请求的 requestBody 为空字符串。

路径参数

invoice_id
string
必填

发票 ID。

响应

查询成功。

id
string
必填

发票 ID。

object
string
必填
示例:

"invoice"

subscription_id
string
必填

关联订阅 ID。

customer
string
必填

客户 ID。

amount_due
integer<int64>
必填

应付金额,使用最小单位。

amount_paid
integer<int64>
必填

已支付金额,使用最小单位。

amount_remaining
integer<int64>
必填

未支付金额,使用最小单位。

currency
string
必填

币种。

status
enum<string>
必填

发票状态。查询参数必须使用小写值:openpaidvoid

可用选项:
open,
paid,
void
payment_status
enum<string>
必填

发票支付状态。

可用选项:
pending,
processing,
completed,
failed,
canceled,
expired
billing_reason
string
必填

开票原因,例如 subscription_createsubscription_cycle

period_start
integer<int64>
必填

计费周期开始,Unix 秒。

period_end
integer<int64>
必填

计费周期结束,Unix 秒。

created
integer<int64>
必填

创建时间,Unix 秒。

frequency
string

计费频率展示文本,例如 Monthly

recurring_interval
enum<string>

重复计费周期。

可用选项:
day,
week,
month,
year
recurring_interval_count
integer<int32>

重复计费周期数量。

payment_id
string

关联支付会话 ID。优先返回 payment_session_id,其次返回 trade_order_id。

paid_at
integer<int64>

支付完成时间,Unix 秒。

due_date
integer<int64>

到期时间,Unix 秒。

Last modified on April 30, 2026