Create Usage Event
curl --request POST \
--url https://api.meetcampfire.com/rev/api/v1/usage-events \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"performance_obligation": 123,
"usage_date": "2023-12-25",
"description": "<string>",
"quantity": 0,
"currency": "<string>"
}
'import requests
url = "https://api.meetcampfire.com/rev/api/v1/usage-events"
payload = {
"performance_obligation": 123,
"usage_date": "2023-12-25",
"description": "<string>",
"quantity": 0,
"currency": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
performance_obligation: 123,
usage_date: '2023-12-25',
description: '<string>',
quantity: 0,
currency: '<string>'
})
};
fetch('https://api.meetcampfire.com/rev/api/v1/usage-events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meetcampfire.com/rev/api/v1/usage-events",
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([
'performance_obligation' => 123,
'usage_date' => '2023-12-25',
'description' => '<string>',
'quantity' => 0,
'currency' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.meetcampfire.com/rev/api/v1/usage-events"
payload := strings.NewReader("{\n \"performance_obligation\": 123,\n \"usage_date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"quantity\": 0,\n \"currency\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.meetcampfire.com/rev/api/v1/usage-events")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"performance_obligation\": 123,\n \"usage_date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"quantity\": 0,\n \"currency\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meetcampfire.com/rev/api/v1/usage-events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"performance_obligation\": 123,\n \"usage_date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"quantity\": 0,\n \"currency\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"performance_obligation": 123,
"obligation_name": "<string>",
"contract": 123,
"contract_name": "<string>",
"contract_number": "<string>",
"client_name": "<string>",
"usage_date": "2023-12-25",
"records": [
{
"id": 123,
"performance_obligation": 123,
"obligation_name": "<string>",
"contract": 123,
"contract_name": "<string>",
"contract_number": "<string>",
"client_name": "<string>",
"usage_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"usage_event": 123,
"description": "<string>",
"quantity": 0,
"rate": 0,
"currency": "<string>",
"amount": 0
}
],
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"quantity": 0,
"currency": "<string>"
}Revenue
Create Usage Event
Reported usage facts — the write path for the usage ledger. Creating an
event prices its quantity into ledger rows (commit vs overage segments),
returned inline as records.
POST
/
rev
/
api
/
v1
/
usage-events
Create Usage Event
curl --request POST \
--url https://api.meetcampfire.com/rev/api/v1/usage-events \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"performance_obligation": 123,
"usage_date": "2023-12-25",
"description": "<string>",
"quantity": 0,
"currency": "<string>"
}
'import requests
url = "https://api.meetcampfire.com/rev/api/v1/usage-events"
payload = {
"performance_obligation": 123,
"usage_date": "2023-12-25",
"description": "<string>",
"quantity": 0,
"currency": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
performance_obligation: 123,
usage_date: '2023-12-25',
description: '<string>',
quantity: 0,
currency: '<string>'
})
};
fetch('https://api.meetcampfire.com/rev/api/v1/usage-events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meetcampfire.com/rev/api/v1/usage-events",
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([
'performance_obligation' => 123,
'usage_date' => '2023-12-25',
'description' => '<string>',
'quantity' => 0,
'currency' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.meetcampfire.com/rev/api/v1/usage-events"
payload := strings.NewReader("{\n \"performance_obligation\": 123,\n \"usage_date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"quantity\": 0,\n \"currency\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.meetcampfire.com/rev/api/v1/usage-events")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"performance_obligation\": 123,\n \"usage_date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"quantity\": 0,\n \"currency\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meetcampfire.com/rev/api/v1/usage-events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"performance_obligation\": 123,\n \"usage_date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"quantity\": 0,\n \"currency\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"performance_obligation": 123,
"obligation_name": "<string>",
"contract": 123,
"contract_name": "<string>",
"contract_number": "<string>",
"client_name": "<string>",
"usage_date": "2023-12-25",
"records": [
{
"id": 123,
"performance_obligation": 123,
"obligation_name": "<string>",
"contract": 123,
"contract_name": "<string>",
"contract_number": "<string>",
"client_name": "<string>",
"usage_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"usage_event": 123,
"description": "<string>",
"quantity": 0,
"rate": 0,
"currency": "<string>",
"amount": 0
}
],
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"quantity": 0,
"currency": "<string>"
}Authorizations
Token-based authentication with required prefix "Token"
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
A reported usage fact — the client write path. The server prices the
quantity into ledger rows (records) on create and re-expands them
on update.
Response
201 - application/json
A reported usage fact — the client write path. The server prices the
quantity into ledger rows (records) on create and re-expands them
on update.
Show child attributes
Show child attributes
Maximum string length:
500Required range:
-100000000000 < x < 100000000000Maximum string length:
3⌘I