Service

Something that an Identity has: a plan, a data allowance, call recording.

An Identity is a User, a Hunt Group or an IVR. Each has a plan, and a User can have more: data, call recording, etc.

app.onsim.uk/services

Inbound & Outboundname

plantype

Inboundname

plantype

4GB Dataname

datatype

Recordingname

recordingtype

✦

AI Insightsname

ai_insightstype

The name of the productname

othertype

Fields

Field	Type	What it is	On app.onsim
id	integer	The ID of the Service. It is the same for every Identity that has the Service.	Not shown.
type	string	The section of the Services tab that holds it: plan, data, recording, ai_insights or other. More values can come.	The section that holds the Service. Each has its own art.
name	string	The name, as app.onsim shows it.	The name of the Service.
descriptionoptional	string	What the Service gives, as app.onsim shows it.	Not shown.
status	"active" | "pending"	pending when the Service has not started yet. A pending Service takes the place of an active one of the same type.	On the page of a User, a pending Service shows as a note of a change that is scheduled.
starts_atoptional	string	When the Service started, or will start. It is not there when the start is not known.	The date in that note.
ends_atoptional	string	When the Service stops. A Service with no end runs until someone changes it.	The same date: the Service that leaves stops when the next one starts.
recordsoptional	Records	Only on a recording Service: what the Identity records.	Not shown.
priceoptional	Price	What the Service costs. It is not there when the Service has no fee, as for a Hunt Group.	The row of its section in Monthly Charges, on the Summary card. A Service of the Other section also shows it beside its name.

Price

What a Service costs for each billing period, with no tax. A Service has no price when it has no fee, as for a Hunt Group. A price is not a charge: a charge is the money for usage.

Field	Type	What it is
amount	number	The money for each period, with no tax. 0 for a Service that costs nothing.
currency	string	The currency of amount, as an ISO 4217 code, such as GBP.
period	"month"	The billing period of amount. More values can come.

Records

Only a recording Service has records. It says what the Identity records.

Field	Type	What it is
calls	boolean	True when the calls of the Identity are recorded.
messagesoptional	boolean	True when the messages of the Identity are recorded. It is not there when we cannot read it at the time of the request.

A change of Service

A change at the end of a billing period shows as two entries of the same type.

• The Service that leaves is active, with an ends_at.
• The Service that takes its place is pending, with a starts_at that is still to come.

A Service that goes away with nothing after it is active with an ends_at, and no pending entry follows.

In the example below, the data of the User goes from 4GB to 2GB at the end of October.

Example

The Services of a User. The plan is first.

GET /v1/services/1043

[
  {
    "id": 55,
    "type": "plan",
    "name": "Inbound & Outbound",
    "description": "Make & Receive Calls From Your Landline",
    "status": "active",
    "starts_at": "2026-06-08T00:00:00Z",
    "price": {
      "amount": 10,
      "currency": "GBP",
      "period": "month"
    }
  },
  {
    "id": 79,
    "type": "data",
    "name": "4GB Data",
    "description": "4GB-DATA",
    "status": "active",
    "starts_at": "2026-09-26T12:29:12Z",
    "ends_at": "2026-10-31T23:54:59Z",
    "price": {
      "amount": 4,
      "currency": "GBP",
      "period": "month"
    }
  },
  {
    "id": 78,
    "type": "data",
    "name": "2GB Data",
    "description": "2GB-DATA",
    "status": "pending",
    "starts_at": "2026-10-31T23:55:00Z",
    "price": {
      "amount": 2,
      "currency": "GBP",
      "period": "month"
    }
  },
  {
    "id": 73,
    "type": "recording",
    "name": "Recording",
    "description": "Records every call and SMS for compliance, training & discovery",
    "status": "active",
    "starts_at": "2025-05-21T12:03:29Z",
    "records": {
      "calls": true,
      "messages": true
    },
    "price": {
      "amount": 10,
      "currency": "GBP",
      "period": "month"
    }
  }
]

Methods

The ID in the path is the ID of the Identity: the same id that a User, a Hunt Group or an IVR has.

Get the Services of an IdentityGET /v1/services/{id}