Usage Events
Get Event
Get an event by its ID.
GET
/
events
/
{event_id}
JavaScript
import DodoPayments from 'dodopayments';
const client = new DodoPayments({
bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});
const event = await client.usageEvents.retrieve('event_id');
console.log(event.business_id);import os
from dodopayments import DodoPayments
client = DodoPayments(
bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted
)
event = client.usage_events.retrieve(
"event_id",
)
print(event.business_id)package main
import (
"context"
"fmt"
"github.com/dodopayments/dodopayments-go"
"github.com/dodopayments/dodopayments-go/option"
)
func main() {
client := dodopayments.NewClient(
option.WithBearerToken("My Bearer Token"),
)
event, err := client.UsageEvents.Get(context.TODO(), "event_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", event.BusinessID)
}package com.dodopayments.api.example;
import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.usageevents.Event;
import com.dodopayments.api.models.usageevents.UsageEventRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();
Event event = client.usageEvents().retrieve("event_id");
}
}package com.dodopayments.api.example
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.usageevents.Event
import com.dodopayments.api.models.usageevents.UsageEventRetrieveParams
fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
val event: Event = client.usageEvents().retrieve("event_id")
}require "dodopayments"
dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)
event = dodo_payments.usage_events.retrieve("event_id")
puts(event)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
$client = new Client(
bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
environment: 'test_mode',
);
try {
$event = $client->usageEvents->retrieve('event_id');
var_dump($event);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.UsageEvents;
DodoPaymentsClient client = new();
UsageEventRetrieveParams parameters = new() { EventID = "event_id" };
var event_ = await client.UsageEvents.Retrieve(parameters);
Console.WriteLine(event_);use dodopayments::Client;
#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let event_id = "event_id";
let result = client
.usage_events()
.retrieve()
.event_id(event_id)
.await?;
println!("{result:?}");
Ok(())
}curl --request GET \
--url https://test.dodopayments.com/events/{event_id} \
--header 'Authorization: Bearer <token>'{
"business_id": "<string>",
"customer_id": "<string>",
"event_id": "<string>",
"event_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"metadata": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique event identifier (case-sensitive, must match the ID used during ingestion)
Response
Event retrieved successfully
Last modified on March 25, 2026
Was this page helpful?
⌘I
JavaScript
import DodoPayments from 'dodopayments';
const client = new DodoPayments({
bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});
const event = await client.usageEvents.retrieve('event_id');
console.log(event.business_id);import os
from dodopayments import DodoPayments
client = DodoPayments(
bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted
)
event = client.usage_events.retrieve(
"event_id",
)
print(event.business_id)package main
import (
"context"
"fmt"
"github.com/dodopayments/dodopayments-go"
"github.com/dodopayments/dodopayments-go/option"
)
func main() {
client := dodopayments.NewClient(
option.WithBearerToken("My Bearer Token"),
)
event, err := client.UsageEvents.Get(context.TODO(), "event_id")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", event.BusinessID)
}package com.dodopayments.api.example;
import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.usageevents.Event;
import com.dodopayments.api.models.usageevents.UsageEventRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();
Event event = client.usageEvents().retrieve("event_id");
}
}package com.dodopayments.api.example
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.usageevents.Event
import com.dodopayments.api.models.usageevents.UsageEventRetrieveParams
fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
val event: Event = client.usageEvents().retrieve("event_id")
}require "dodopayments"
dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)
event = dodo_payments.usage_events.retrieve("event_id")
puts(event)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
$client = new Client(
bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
environment: 'test_mode',
);
try {
$event = $client->usageEvents->retrieve('event_id');
var_dump($event);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.UsageEvents;
DodoPaymentsClient client = new();
UsageEventRetrieveParams parameters = new() { EventID = "event_id" };
var event_ = await client.UsageEvents.Retrieve(parameters);
Console.WriteLine(event_);use dodopayments::Client;
#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let event_id = "event_id";
let result = client
.usage_events()
.retrieve()
.event_id(event_id)
.await?;
println!("{result:?}");
Ok(())
}curl --request GET \
--url https://test.dodopayments.com/events/{event_id} \
--header 'Authorization: Bearer <token>'{
"business_id": "<string>",
"customer_id": "<string>",
"event_id": "<string>",
"event_name": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"metadata": {}
}