Send Usage

This API endpoint allows you to send meter usage data for individual customers to the Stykite platform. The provided data will be used to generate invoices based on the recorded usage. This process ensures accurate billing and helps manage customer consumption effectively.

Request Parameters

Path Parameters:

company_id (string, required): The unique identifier of the company.

country_id (string, required): The unique identifier of the country.

customer_identifier (string, required): A unique identifier for the customer.

Headers:

Authorization (string, required): The authorization token in the format Bearer .

Content-Type (string, required): The content type of the request, should be application/json.

Body Parameters:

An array of meter usage data objects.

timestamp (number, required): The timestamp of the meter reading.

meter_id (string, required): The unique identifier of the meter associated with the usage data.

qty (number, required): The quantity of usage recorded till timestamp.

Response

Upon successful submission of the meter usage data, the API returns a response with status code 202 Accepted confirming the receipt of the data

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

companyId

string

required

Example:

countryId

string

required

Example:

customerIdentifier

string

required

Example:

Header Params

Authorization

string

required

Example:

Bearer {{AUTH_TOKEN}}

content-type

string

required

Example:

application/json

Body Params application/json

array of:

timestamp

integer

optional

meter_id

string

optional

qty

integer

optional

Example

[
    {
        "timestamp": 1697363618832,
        "meter_id": "MTR-0DWBEZWHFSBBQ",
        "qty": 26
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request Parameters#

Response#

Request

Request samples

Responses

Request Parameters

Response