Subscription

Query subscription

Changed on
get/subscription

Request

Query parameters

merchant_sub_idstring string required

商户订阅ID

Headers

X-API-Key-IDstring required

32-character Base58 credential ID returned after public-key registration.

X-API-Timestampstring required

Unix timestamp in seconds; tolerance is ±300 seconds.

X-API-Noncestring required

16 cryptographically random bytes encoded as unpadded Base64URL; fresh on every attempt.

Digeststring required

SHA-256= followed by standard padded Base64 of SHA-256 of exact request body bytes. Required even for an empty body; included in the signing string.

Authorizationstring required

Use Ed25519 signature="BASE64_SIGNATURE", where BASE64_SIGNATURE is the standard padded Base64 signature. See /docs/en/4-authorization for the exact signing string.

Response

subscription_idstring string

系统订阅ID

merchant_sub_idstring string

商户订阅ID

plan_namestring string

计划名称

trigger_methodstring string

触发方式

statusstring string

订阅状态

cancel_reasonstring string

取消原因

canceled_atinteger

取消时间 (unix timestamp)

currencystring string

币种

first_amountstring string

首期金额

amountstring string

后续每期金额

interval_unitstring string

周期单位

interval_countinteger

周期数量

current_period_startinteger

当前周期开始 (unix timestamp)

current_period_endinteger

当前周期结束 (unix timestamp)

subscription_end_atinteger

订阅终止时间 (unix timestamp)

next_invoice_atinteger

下次发送 Invoice 时间 (unix timestamp)

payer_emailstring string

付款人邮箱

created_atinteger

创建时间 (unix timestamp)

updated_atinteger

更新时间 (unix timestamp)

Changes

    • breaking

      added the new required header request parameter Digest

    • breaking

      added the new required header request parameter X-API-Key-ID

    • breaking

      added the new required header request parameter X-API-Nonce

    • breaking

      added the new required header request parameter X-API-Timestamp

    • breaking

      the header request parameter Authorization became required

    • warning

      deleted the header request parameter Date

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status