Estimate event credit cost

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.events.estimate({ customerId: 'customerId', eventName: 'x' });

console.log(response.data);

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
response = client.v1.events.estimate(
    customer_id="customerId",
    event_name="x",
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.V1.Events.Estimate(context.TODO(), stigg.V1EventEstimateParams{
		CustomerID: "customerId",
		EventName:  "x",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.events.EventEstimateParams;
import io.stigg.models.v1.events.EventEstimateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        EventEstimateParams params = EventEstimateParams.builder()
            .customerId("customerId")
            .eventName("x")
            .build();
        EventEstimateResponse response = client.v1().events().estimate(params);
    }
}

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Events;

StiggClient client = new();

EventEstimateParams parameters = new()
{
    CustomerID = "customerId",
    EventName = "x",
};

var response = await client.V1.Events.Estimate(parameters);

Console.WriteLine(response);

curl --request POST \
  --url https://api.stigg.io/api/v1/events/estimate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "eventName": "<string>",
  "customerId": "<string>",
  "resourceId": "<string>",
  "dimensions": {}
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/events/estimate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'eventName' => '<string>',
    'customerId' => '<string>',
    'resourceId' => '<string>',
    'dimensions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "estimates": [
      {
        "currencyId": "<string>",
        "estimatedCost": 123,
        "currentBalance": 123,
        "balanceAfterEstimate": 123,
        "wouldOverdraft": true,
        "breakdown": [
          {
            "featureId": "<string>",
            "cost": 123,
            "warningCode": "UNSUPPORTED_AGGREGATION"
          }
        ]
      }
    ],
    "warnings": [
      "RESOURCE_SCOPED_SUBSCRIPTION_EXISTS"
    ]
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "CustomerNotFound"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

POST

api

events

estimate

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1.events.estimate({ customerId: 'customerId', eventName: 'x' });

console.log(response.data);

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
response = client.v1.events.estimate(
    customer_id="customerId",
    event_name="x",
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.V1.Events.Estimate(context.TODO(), stigg.V1EventEstimateParams{
		CustomerID: "customerId",
		EventName:  "x",
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.events.EventEstimateParams;
import io.stigg.models.v1.events.EventEstimateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        EventEstimateParams params = EventEstimateParams.builder()
            .customerId("customerId")
            .eventName("x")
            .build();
        EventEstimateResponse response = client.v1().events().estimate(params);
    }
}

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Events;

StiggClient client = new();

EventEstimateParams parameters = new()
{
    CustomerID = "customerId",
    EventName = "x",
};

var response = await client.V1.Events.Estimate(parameters);

Console.WriteLine(response);

curl --request POST \
  --url https://api.stigg.io/api/v1/events/estimate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "eventName": "<string>",
  "customerId": "<string>",
  "resourceId": "<string>",
  "dimensions": {}
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/events/estimate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'eventName' => '<string>',
    'customerId' => '<string>',
    'resourceId' => '<string>',
    'dimensions' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "estimates": [
      {
        "currencyId": "<string>",
        "estimatedCost": 123,
        "currentBalance": 123,
        "balanceAfterEstimate": 123,
        "wouldOverdraft": true,
        "breakdown": [
          {
            "featureId": "<string>",
            "cost": 123,
            "warningCode": "UNSUPPORTED_AGGREGATION"
          }
        ]
      }
    ],
    "warnings": [
      "RESOURCE_SCOPED_SUBSCRIPTION_EXISTS"
    ]
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "CustomerNotFound"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

Authorizations

X-API-KEY

string

header

required

Server API Key

Headers

X-ACCOUNT-ID

string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID

string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Estimate the credit cost of a usage event before reporting it

eventName

string

required

The name of the usage event

Required string length: 1 - 255

customerId

string

required

Customer id

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$

resourceId

string | null

The customer resource this usage applies to. Optional — only required if the customer has multiple resources (for example, one subscription per workspace or site) and usage needs to be tracked separately per resource; omit it to report usage at the customer level.

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

dimensions

object

Dimensions associated with the usage event

Show child attributes

Response

The credit cost estimation, including per-currency costs, balances, and warnings.

Response object

data

CreditCostEstimation · object

required

Estimated credit cost, current balance and balance after

Show child attributes

Get started

Essentials

Subscriptions

Bulk Import

Usage

Coupons

Products

Features

Addons

Plans

Promotional Entitlements

Customers

Customer Integrations

Data Export

Entitlements

Plan Entitlements

Addon Entitlements

Credit grants

Credit consumption

Credit usage

Auto recharge

Custom currencies

Credit ledger

Contracts

Invoices

Governance Entity Types

Governance Entities

Governance Assignments

Governance Hierarchy

Governance Entitlements Check

Estimate event credit cost

Authorizations

Headers

Body

Response