Get Earned Premium (Single Policy)

curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium', 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://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "policyId": "550e8400-e29b-41d4-a716-446655440001",
  "policyNumber": "POL-2025-001",
  "earnedPremiumTotal": 42465.75,
  "transactionTotals": [
    {
      "transactionId": "660e8400-e29b-41d4-a716-446655440001",
      "policyVersion": 1,
      "action": "NEW_BUSINESS",
      "totalContribution": 42465.75
    }
  ]
}

Earned Premium

Get Earned Premium (Single Policy)

Returns earned premium for a single policy over a date range. Each transaction on the policy produces a daily contribution (a fixed daily rate over its effective range), and the earned premium on any given day is the sum of all active contributions.

Use the detail parameter to control response granularity:

transactions (default) — transaction-level totals only
days — adds a daily time series of net earned premium
daysAndTransactions — adds a daily time series with per-transaction contributions on each day

The date range is a half-open interval [startDate, endDate) and must not exceed 366 days.

Use timeTravelBackToDate to see earned premium as it would have been calculated at a prior point in time — only transactions created before that timestamp are included.

Required permission: company.policy:read

GET

api

external

companies

{companyId}

policies

{policyId}

earned-premium

Get Earned Premium (Single Policy)

curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium', 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://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/v1/external/companies/{companyId}/policies/{policyId}/earned-premium")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "policyId": "550e8400-e29b-41d4-a716-446655440001",
  "policyNumber": "POL-2025-001",
  "earnedPremiumTotal": 42465.75,
  "transactionTotals": [
    {
      "transactionId": "660e8400-e29b-41d4-a716-446655440001",
      "policyVersion": 1,
      "action": "NEW_BUSINESS",
      "totalContribution": 42465.75
    }
  ]
}

Authorizations

Authorization

string

header

required

API key authentication. Include your API key in the Authorization header.

Path Parameters

companyId

string<uuid>

required

Company identifier

policyId

string<uuid>

required

Policy identifier

Query Parameters

startDate

string<date>

required

Start of the earned premium window (inclusive). ISO 8601 date (YYYY-MM-DD). Must be before or equal to endDate.

endDate

string<date>

required

End of the earned premium window (exclusive). ISO 8601 date (YYYY-MM-DD). The range [startDate, endDate) must not exceed 366 days.

detail

enum<string>

default:transactions

Response granularity:

transactions — transactionTotals only (default)
days — adds days array with net earned premium per day
daysAndTransactions — adds days array with per-transaction contributions on each day

Available options:

transactions,

days,

daysAndTransactions

timeTravelBackToDate

string<date-time>

Only include transactions created before this timestamp (ISO 8601). Useful for auditing historical earned premium state.

Response

Earned premium for the policy

Earned premium for a single policy over the requested date range. Shape varies by detail level: - transactions — transactionTotals only (default) - days — adds days array (without per-transaction contributions) - daysAndTransactions — adds days array with contributions per day

policyId

string<uuid>

required

The policy ID

policyNumber

string

required

Human-readable policy number

earnedPremiumTotal

number

required

Total earned premium across all transactions for the requested date range

transactionTotals

object[]

required

Each transaction's total earned premium contribution over the requested date range. Always present.

Show child attributes

days

object[]

Daily earned premium time series. Only present when detail=days or detail=daysAndTransactions. Contains one entry per day in the half-open interval [startDate, endDate).

Show child attributes

Get Policy Transaction List Earned Premium (Multi-Policy)

⌘I