Skip to main content
POST
Preview Subscription Update

Authorizations

X-API-KEY
string
header
required

Your secret API key obtained from the Clink dashboard (Developers section)

Headers

X-Timestamp
string
required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Example:

"1783513683000"

Path Parameters

id
string
required

Unique identifier of the subscription

Body

application/json

Subscription update preview request

Parameters required to preview a subscription upgrade or downgrade.

priceId
string
required

Target recurring price ID. The price must belong to the current merchant and support the subscription payment currency.

promotionCode
string

Promotion code to apply to the updated subscription.

Response

Subscription update preview returned successfully

code
integer<int32>

Response status code, 200 when success

Example:

200

msg
string

Brief description of what happened, 'success' when happy case

Example:

"success"

data
object

Preview result for a subscription upgrade or downgrade.