HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Session / Expedite billing

Run the billing validation for a finished session that is still awaiting it, instead of waiting for the platform to
process it. The action runs as the token owner, who is recorded on the session edit log and on the action audit
record.

Requires the Sessions.resume-billing permission - a token whose admin does not hold it is rejected with 403, and so
is a request for a session that belongs to another operator. An unknown session ID is rejected with 404.

Preconditions, with the response code each failure produces:

  • status is finished and billingStatus is pending - otherwise 409
  • Idle fees are no longer accruing: the connector is disengaged, or the platform settings do not defer billing
    until the connector is disengaged - otherwise 409
  • Billing for the session is not owned by the upstream roaming partner - otherwise 409
  • No recalculation is running for the session and the session is not locked for billing processing - otherwise 423
  • reason is at most 1000 characters - otherwise 422

The validation decides the resulting billing status:

Validation outcomeResulting billing status
Every validation rule passescompleted
A validation rule fails and is configured to suspend billingsuspended
A validation rule fails but is not configured to suspend billingcompleted
The session extends an earlier one while the platform settings do not bill extending sessions, or it is a free session on a personal charge pointcompleted, without running the validation rules
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of the session

Body Params
string
length ≤ 1000

Reason for expediting billing, recorded on the session edit log.

Responses
202

Action accepted. The billing validation has been run and the billing status updated accordingly.

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json