Subscription

Cancel subscription

Changed on
post/subscription/cancel

Request

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.

Request body

merchant_sub_idstring string required

商户订阅ID

cancel_reason'user_request' | 'by_merchant_api' | 'by_operation' string required

Cancel reason: user_request / by_merchant_api / by_operation

notestring string

备注

Response

subscription_idstring string

系统订阅ID

merchant_sub_idstring string

商户订阅ID

statusstring string

订阅状态

canceled_atinteger

取消时间 (unix timestamp)

cancel_reasonstring string

取消原因

Changes

    • 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

    • breaking

      the header request parameter Digest 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