Skip to main content
GET
/
price
cURL
curl --request GET \
  --url https://uat-api.clinkbill.com/api/price \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-Timestamp: <api-key>'
{
  "total": 123,
  "rows": [
    {
      "priceId": "<string>",
      "productId": "<string>",
      "currency": "USD",
      "unitAmount": 123,
      "priceType": "one_time",
      "recurring": {
        "interval": "day",
        "trial_period_days": 123,
        "pricing_model": "flat_rate",
        "transform_quantity": {
          "divideBy": 123,
          "round": "up"
        }
      },
      "active": true,
      "createTime": 123
    }
  ],
  "code": 123,
  "msg": "<string>"
}

Authorizations

X-API-KEY
string
header
required

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

X-Timestamp
string
header
required

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

Query Parameters

productId
string
required

Unique identifier of the product configured in your dashboard

pageNum
integer<int32>
required

Current page number,and the default is 1

pageSize
integer<int32>
required

Size of the query results per page,pageSize can range between 1 and 100

active
boolean
required

Is it available for purchase

Response

Price details retrieved successfully

Table Paging Data Object

total
integer<int64>

Total number of records

rows
object[]

List of data

code
integer<int32>

Response status code, 200 when success

msg
string

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