Search
K
Usage Chargeback & Settlement

Usage Chargeback & Settlement

1.0.0OAS 3.0

Settles the usage chargeback after a billing period closes: create a
settlement, retrieve the invoice, record incoming cost-center payments.

The chargeback rate is set per business unit under the platform’s
internal cost-allocation policy. For a heavily subsidized deployment -
such as a pilot funded partly from the shared platform budget - the
consuming team’s rate typically must not exceed the unit’s approved
ceiling. The API validates the rate against that ceiling when a
settlement is created.

API Base URL
  • Server 1:https://api.nexora.example/v1

    Production

  • Server 2:https://sandbox.api.nexora.example/v1

    Sandbox

Security
apiKey (apiKey)

Every call carries an API key in the apikey header. You generate the
key in the Nexora AI portal under “My Apps”; it’s shown exactly once.

Each key has the scopes it’s allowed to use attached to it. If one is
missing, the API responds with 403 and code: "scope_missing"; the
missing scope is in details[].field.

Additional Information
Contact API Support - Nexora AI (api-support@nexora.example)

For demonstration purposes only License

Settlements

List settlements

get

Query Parameters

statusstring

Allowed values:draftopenpartially_paidpaidcanceled

Example:open

agent_idstring

Example:agt_8f2c1a

period_fromstring(date)
period_tostring(date)

Response

application/json

Results list

dataarray[object]
Show Child Parameters
pageobject

Cursor-based pagination.

Show Child Parameters
get/settlements
 
application/json

Create a settlement

Creates the settlement for a completed billing period. The basis is
the metered usage cost for that period.

post

Body

application/json

SettlementCreate

agent_idstringrequired

Example:agt_8f2c1a

usage_typestringrequired

Allowed values:standardburstreserved

Example:standard

billing_basis_usdnumber(float)required

Total metered usage cost for the billing period, before the chargeback rate is applied.

Example:6380

chargeback_rate_percentnumber(float)required

Example:12

period_end_datestring(date)required

Example:2026-08-31

cost_centerobject
Show Child Parameters

Response

application/json

Created

Settlement

idstring

Example:stl_7c53

agent_idstring

Example:agt_8f2c1a

statusstring

Allowed values:draftopenpartially_paidpaidcanceled

Example:open

usage_typestring

Allowed values:standardburstreserved

Example:standard

billing_basis_usdnumber(float)

Example:6380

line_itemsarray[object]
Show Child Parameters
invoice_idstring

Example:inv_a920

due_datestring(date)

Example:2026-09-14

paid_usdnumber(float)

Example:0

created_atstring(date-time)

Example:2026-08-15T07:30:00Z

post/settlements

Body

{ "agent_id": "agt_8f2c1a", "usage_type": "standard", "billing_basis_usd": 6380, "chargeback_rate_percent": 12, "period_end_date": "2026-08-31", "cost_center": { "name": "Customer Success", "cost_center_id": "CC-4021", "business_unit": "Support Engineering" } }
 
application/json

Retrieve a settlement

get

Path Parameters

settlementIdstringrequired

Example:stl_7c53

Response

application/json

Settlement

Settlement

idstring

Example:stl_7c53

agent_idstring

Example:agt_8f2c1a

statusstring

Allowed values:draftopenpartially_paidpaidcanceled

Example:open

usage_typestring

Allowed values:standardburstreserved

Example:standard

billing_basis_usdnumber(float)

Example:6380

line_itemsarray[object]
Show Child Parameters
invoice_idstring

Example:inv_a920

due_datestring(date)

Example:2026-09-14

paid_usdnumber(float)

Example:0

created_atstring(date-time)

Example:2026-08-15T07:30:00Z

get/settlements/{settlementId}
 
application/json