Usage

Usage

Get all product usage

get

https://api.plock.iohttps://test-api.plock.io

/api/c1/product-usages

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

Header parameters

Acceptstring · enumRequired

The client must specify an Accept header.

Possible values:

Responses

200

OK

application/vnd.api+json

401

Unauthorized

application/vnd.api+json

get

/api/c1/product-usages

HTTPcURLJavaScriptPython

GET /api/c1/product-usages HTTP/1.1
Host: api.plock.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/vnd.api+json

{
  "meta": {
    "page": {
      "currentPage": 1,
      "from": 1,
      "lastPage": 1,
      "perPage": 1,
      "to": 1,
      "total": 1
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "text",
    "last": "text",
    "next": "text"
  },
  "data": [
    {
      "type": "product-usage",
      "id": "2002",
      "attributes": {
        "accountId": 13321,
        "crmId": "a341324",
        "productId": 41231,
        "value": 1.0576,
        "timestamp": "2025-05-30T00:00:00.000000Z"
      },
      "relationships": {},
      "links": {
        "self": "text"
      }
    }
  ]
}

Add product usage

post

https://api.plock.iohttps://test-api.plock.io

/api/c1/product-usages

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Acceptstring · enumRequired

The client must specify an Accept header.

Possible values:

Content-Typestring · enumRequired

The client must specify a Content-Type header.

Possible values:

Body

application/json

tsintegerOptional

UNIX timestamp of value

Example: 1756582856

valuenumber · floatOptional

Value recorded at ts

Example: 10.5

crm_idstringOptional

CRM ID of the account

Example: xx123

product_idintegerOptional

Product ID for the product

Example: 332

Responses

200

OK

application/json

401

Unauthorized

application/json

404

Not found

application/json

422

Unprocessable content

application/json

post

/api/c1/product-usages

HTTPcURLJavaScriptPython

POST /api/c1/product-usages HTTP/1.1
Host: api.plock.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
Content-Type: application/json
Content-Length: 64

{
  "ts": 1756582856,
  "value": 10.5,
  "crm_id": "xx123",
  "product_id": 332
}

{
  "success": true
}