Seat-based true-up API

Computes the prorated mid-term true-up charge or credit for seats added or removed and the next-period recurring charge at the new seat count. Answers 'What is the true-up for adding 5 seats mid-term?', 'What will I be billed next period?'.

Price$0.02per request

MethodPOST

Route/v1/commerce/seat-true-up

StatusLive

MIME typeapplication/json

Rate limit120/minute

Cache0s public

commercesubscriptionseatstrue-upsaasprorationper-seatbilling

API URLhttps://x402.hexl.dev/v1/commerce/seat-true-up

Integration docs

Example request

{
  "pricePerSeat": 20,
  "startingSeats": 10,
  "endingSeats": 15,
  "termDays": 30,
  "daysIntoTermAtChange": 12
}

Example response

{
  "pricePerSeat": 20,
  "startingSeats": 10,
  "endingSeats": 15,
  "seatDelta": 5,
  "termDays": 30,
  "daysIntoTermAtChange": 12,
  "remainingDays": 18,
  "prorationFraction": 0.6,
  "trueUpAmount": 60,
  "direction": "seats-added (charge)",
  "nextPeriodRecurring": 300,
  "interpretation": "5 seat(s) added mid-term -> charge $60 now; next period $300."
}

Input schema

{
  "type": "object",
  "required": [
    "pricePerSeat",
    "startingSeats",
    "endingSeats",
    "termDays",
    "daysIntoTermAtChange"
  ],
  "properties": {
    "pricePerSeat": {
      "type": "number",
      "examples": [
        20
      ]
    },
    "startingSeats": {
      "type": "integer",
      "examples": [
        10
      ]
    },
    "endingSeats": {
      "type": "integer",
      "examples": [
        15
      ]
    },
    "termDays": {
      "type": "integer",
      "examples": [
        30
      ]
    },
    "daysIntoTermAtChange": {
      "type": "integer",
      "examples": [
        12
      ]
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}