Products

The following endpoints allow you to view the products and price lists configured for your partner account.

Get products

get
Authorizations
Responses
200

An array with all available partner products

application/json
get
GET /api/portal/products HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

An array with all available partner products

{
  "result": [
    {
      "id": "text",
      "type": "SUBSCRIPTION",
      "code": "text",
      "name": "text",
      "prices": [
        {
          "id": 1,
          "frequency": "MONTH",
          "price_list": {
            "id": 1,
            "code": "text"
          }
        }
      ],
      "features": [
        {
          "code": "text",
          "name": "text",
          "type": "BOOLEAN",
          "value": 1
        }
      ]
    }
  ]
}

Get product

get

Retrieve information about a single product

Authorizations
Path parameters
productIdstringRequired

Product id or code

Responses
200

The partner product information

application/json
get
GET /api/portal/products/{productId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

The partner product information

{
  "result": {
    "id": "text",
    "type": "SUBSCRIPTION",
    "code": "text",
    "name": "text",
    "prices": [
      {
        "id": 1,
        "frequency": "MONTH",
        "price_list": {
          "id": 1,
          "code": "text"
        }
      }
    ],
    "features": [
      {
        "code": "text",
        "name": "text",
        "type": "BOOLEAN",
        "value": 1
      }
    ]
  }
}

Last updated