API reference
Products
The products and price lists available to the partner.
Get products
GET
200An array with all available partner productsapplication/json
Show properties
The product id
The product type. ADD_ON is returned for insurer partners.
Possible values:
SUBSCRIPTION ADD_ONThe product code
The product name
A list of product prices available
Show properties
The product price id
The price frequency
Possible values:
MONTH YEARThe price list
Show properties
The price list id
The price list code
Optional available add-on products
Show properties
Optional available product features
Show properties
The feature code
The feature name
The feature type
Possible values:
BOOLEAN MAX_VALUEget/portal/products
GET /api/portal/products HTTP/1.1 Host: partners.clym.io Authorization: Bearer YOUR_SECRET_TOKEN Accept: */*
200An array with all available partner products
{
"result": [{
"id": 0,
"type": "SUBSCRIPTION",
"code": "string",
"name": "string",
"prices": [{
"id": 0,
"frequency": "MONTH",
"price_list": {
"id": {},
"code": {}
}
}],
"children": [{
"id": "string",
"code": "string",
"name": "string",
"type": "ADD_ON",
"description": "string",
"support_url": "string"
}],
"features": [{
"code": "string",
"name": "string",
"type": "BOOLEAN",
"value": null
}]
}]
}Get product
GET
Retrieve information about a single product
Path parameters:
| Name | Type | Required | Description |
|---|---|---|---|
productId |
string | Yes | Product id or code |
200The partner product informationapplication/json
A product object
Show properties
The product id
The product type. ADD_ON is returned for insurer partners.
Possible values:
SUBSCRIPTION ADD_ONThe product code
The product name
A list of product prices available
Show properties
The product price id
The price frequency
Possible values:
MONTH YEARThe price list
Show properties
The price list id
The price list code
Optional available add-on products
Show properties
Optional available product features
Show properties
The feature code
The feature name
The feature type
Possible values:
BOOLEAN MAX_VALUEget/portal/products/{productId}
GET /api/portal/products/{productId} HTTP/1.1 Host: partners.clym.io Authorization: Bearer YOUR_SECRET_TOKEN Accept: */*
200The partner product information
{
"result": {
"id": 0,
"type": "SUBSCRIPTION",
"code": "string",
"name": "string",
"prices": [{
"id": 0,
"frequency": "MONTH",
"price_list": {
"id": 0,
"code": "string"
}
}],
"children": [{
"id": "string",
"code": "string",
"name": "string",
"type": "ADD_ON",
"description": "string",
"support_url": "string"
}],
"features": [{
"code": "string",
"name": "string",
"type": "BOOLEAN",
"value": null
}]
}
}