Platform API ClientClient group3 methodsMeteringMethods

Metering

Manage milestone thresholds and list webhook delivery outcomes for usage milestone notifications.

Milestone configWebhook delivery history

Metering

metering.getMilestones()

Generated exampleHTTP endpoint wrapperGET /api/v1/metering/milestones

GET /api/v1/metering/milestones

Signature

getMilestones(): Promise<MilestoneConfigResponse>

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

response = platform.metering.getMilestones()
print(response)

Response

// Response type
Promise<MilestoneConfigResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

metering.updateMilestones()

Generated exampleHTTP endpoint wrapperPUT /api/v1/metering/milestones

PUT /api/v1/metering/milestones

Signature

updateMilestones(input: { configs: MilestoneConfigInput[] }): Promise<MilestoneConfigResponse>

Parameters

Name	Type	Flags
input	{ configs: MilestoneConfigInput[] }	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # { configs: MilestoneConfigInput[] }

response = platform.metering.updateMilestones(input)
print(response)

Response

// Response type
Promise<MilestoneConfigResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

metering.listMilestoneDeliveries()

Generated exampleHTTP endpoint wrapperGET /api/v1/metering/milestones/deliveries

GET /api/v1/metering/milestones/deliveries

Signature

listMilestoneDeliveries(params?: {
    operationType?: string;
    status?: string;
    cursor?: string;
    limit?: number;
  }): Promise<MilestoneDeliveryListResponse>

Parameters

Name	Type	Flags
params	{ operationType?: string; status?: string; cursor?: string; limit?: number; }	optional

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

params = {}  # {
    operationType?: string;
    status?: string;
    cursor?: string;
    limit?: number;
  }

response = platform.metering.listMilestoneDeliveries(params)
print(response)

Response

// Response type
Promise<MilestoneDeliveryListResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));