Skip to main content
POST
/
events
/
ingest
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 response = await client.usageEvents.ingest({
  events: [
    {
      customer_id: 'customer_id',
      event_id: 'event_id',
      event_name: 'event_name',
    },
  ],
});

console.log(response.ingested_count);
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
)
response = client.usage_events.ingest(
events=[{
"customer_id": "customer_id",
"event_id": "event_id",
"event_name": "event_name",
}],
)
print(response.ingested_count)
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"),
)
response, err := client.UsageEvents.Ingest(context.TODO(), dodopayments.UsageEventIngestParams{
Events: dodopayments.F([]dodopayments.EventInputParam{{
CustomerID: dodopayments.F("customer_id"),
EventID: dodopayments.F("event_id"),
EventName: dodopayments.F("event_name"),
}}),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.IngestedCount)
}
package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.usageevents.EventInput;
import com.dodopayments.api.models.usageevents.UsageEventIngestParams;
import com.dodopayments.api.models.usageevents.UsageEventIngestResponse;

public final class Main {
private Main() {}

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

UsageEventIngestParams params = UsageEventIngestParams.builder()
.addEvent(EventInput.builder()
.customerId("customer_id")
.eventId("event_id")
.eventName("event_name")
.build())
.build();
UsageEventIngestResponse response = client.usageEvents().ingest(params);
}
}
package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.usageevents.EventInput
import com.dodopayments.api.models.usageevents.UsageEventIngestParams
import com.dodopayments.api.models.usageevents.UsageEventIngestResponse

fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

val params: UsageEventIngestParams = UsageEventIngestParams.builder()
.addEvent(EventInput.builder()
.customerId("customer_id")
.eventId("event_id")
.eventName("event_name")
.build())
.build()
val response: UsageEventIngestResponse = client.usageEvents().ingest(params)
}
require "dodopayments"

dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)

response = dodo_payments.usage_events.ingest(
events: [{customer_id: "customer_id", event_id: "event_id", event_name: "event_name"}]
)

puts(response)
<?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 {
$response = $client->usageEvents->ingest(
events: [
[
'customerID' => 'customer_id',
'eventID' => 'event_id',
'eventName' => 'event_name',
'metadata' => ['foo' => 'string'],
'timestamp' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
],
],
);

var_dump($response);
} catch (APIException $e) {
echo $e->getMessage();
}
using System;
using System.Collections.Generic;
using DodoPayments.Client;
using DodoPayments.Client.Models.UsageEvents;

DodoPaymentsClient client = new();

UsageEventIngestParams parameters = new()
{
Events =
[
new()
{
CustomerID = "customer_id",
EventID = "event_id",
EventName = "event_name",
Metadata = new Dictionary<string, EventInputMetadata>()
{
{ "foo", "string" }
},
Timestamp = DateTimeOffset.Parse("2019-12-27T18:11:19.117Z"),
},
],
};

var response = await client.UsageEvents.Ingest(parameters);

Console.WriteLine(response);
use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let result = client
.usage_events()
.ingest()
.body(dodopayments::models::UsageEventsIngestParams {
events: Some(vec![dodopayments::models::EventInput {
customer_id: "customer_id".to_string(),
event_id: "event_id".to_string(),
event_name: "event_name".to_string(),
metadata: None,
timestamp: None,
}]),
..Default::default()
})
.await?;
println!("{result:?}");
Ok(())
}
curl --request POST \
--url https://test.dodopayments.com/events/ingest \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"events": [
{
"customer_id": "<string>",
"event_id": "<string>",
"event_name": "<string>",
"metadata": {},
"timestamp": "2023-11-07T05:31:56Z"
}
]
}
'
{
  "ingested_count": 1
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
events
object[]
required

List of events to be pushed

Required array length: 1 - 1000 elements

Response

Events ingested successfully

ingested_count
integer
required
Required range: x >= 0
Last modified on March 25, 2026