Skip to main content
POST
Confirm 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 confirmation request

Parameters required to confirm a subscription upgrade or downgrade.

priceSnapshotId
string
required

Target price snapshot ID returned by the preview API.

quantity
integer
default:1

Number of units for the target price. Optional; defaults to 1 when omitted. null and values below 1 are invalid.

Required range: x >= 1
promotionCode
string

Promotion code to apply to the updated subscription.

Response

Subscription update confirmed 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

Result returned after confirming a subscription update.