Rates API — Per-Tenant Billing Rate Plan Management

Rates define the per-minute charge applied to calls that match a given dialled prefix. Each rate is scoped to a single tenant and associates a destination label with a cost_per_minute and a billing_increment (the granularity in seconds at which the call is metered). The platform evaluates CDRs against the tenant’s rate table at call completion to calculate the cost value stored on the CDR. All endpoints require an active admin session. The list endpoint supports an optional search parameter that matches against prefix, destination, and status.

GET /api/rates

Returns all rates ordered by creation date descending, with the parent tenant relation included. Query parameters

string

Optional. Filters rates whose prefix, destination, or status contains the given string (case-insensitive).

string

Value is "Rates fetched successfully.".

array

Array of rate objects.

Show rate object fields

integer

Auto-incremented primary key.

integer

ID of the tenant this rate belongs to.

string

The dialled-number prefix this rate applies to, e.g. "1212" or "44".

string

Human-readable destination label, e.g. "US New York" or "UK Landline".

string

Per-minute charge as a decimal with up to four decimal places, e.g. "0.0120".

integer

Billing granularity in seconds. Call duration is rounded up to the nearest increment before calculating cost.

string

Lifecycle status, e.g. active or inactive.

object

The parent tenant object.

string

ISO 8601 creation timestamp.

string

ISO 8601 last-updated timestamp.

curl https://your-instance.laracopilot.com/api/rates \
  -H "Accept: application/json" \
  -b cookies.txt

curl "https://your-instance.laracopilot.com/api/rates?search=UK" \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Rates fetched successfully.",
  "data": [
    {
      "id": 1,
      "tenant_id": 1,
      "prefix": "1212",
      "destination": "US New York",
      "cost_per_minute": "0.0120",
      "billing_increment": 60,
      "status": "active",
      "tenant": { "id": 1, "name": "Acme Corp" },
      "created_at": "2025-01-20T08:00:00.000000Z",
      "updated_at": "2025-01-20T08:00:00.000000Z"
    }
  ]
}

POST /api/rates

Creates a new rate and returns 201 Created with the record.

integer

required

ID of the tenant to assign this rate to. Must reference an existing tenant.

string

required

The dialled-number prefix that triggers this rate, e.g. "44". Maximum 50 characters.

string

required

Human-readable destination label. Maximum 255 characters.

number

required

Per-minute charge as a decimal number. Must be 0 or greater.

integer

required

Billing granularity in seconds. Minimum value: 1. Common values are 6, 30, or 60.

string

required

Lifecycle status, e.g. active or inactive. Maximum 50 characters.

string

Value is "Rate created successfully.".

object

The newly created rate record.

curl -X POST https://your-instance.laracopilot.com/api/rates \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -b cookies.txt \
  -d '{
    "tenant_id": 1,
    "prefix": "44",
    "destination": "UK Landline",
    "cost_per_minute": 0.0250,
    "billing_increment": 60,
    "status": "active"
  }'

{
  "message": "Rate created successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "prefix": "44",
    "destination": "UK Landline",
    "cost_per_minute": "0.0250",
    "billing_increment": 60,
    "status": "active",
    "created_at": "2025-04-22T11:00:00.000000Z",
    "updated_at": "2025-04-22T11:00:00.000000Z"
  }
}

GET /api/rates/

Fetches a single rate by its ID. Includes the parent tenant relation. Path parameters

integer

required

The numeric ID of the rate to retrieve.

string

Value is "Rate loaded successfully.".

object

The rate record with the tenant relation included.

curl https://your-instance.laracopilot.com/api/rates/2 \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Rate loaded successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "prefix": "44",
    "destination": "UK Landline",
    "cost_per_minute": "0.0250",
    "billing_increment": 60,
    "status": "active",
    "tenant": { "id": 1, "name": "Acme Corp" },
    "created_at": "2025-04-22T11:00:00.000000Z",
    "updated_at": "2025-04-22T11:00:00.000000Z"
  }
}

PUT /api/rates/

Replaces all fields on an existing rate. PATCH /api/rates/{rate} is also accepted and uses the same handler. Path parameters

integer

required

The numeric ID of the rate to update.

integer

required

Must reference an existing tenant.

string

required

Maximum 50 characters.

string

required

Maximum 255 characters.

number

required

Must be 0 or greater.

integer

required

Minimum value: 1.

string

required

Maximum 50 characters.

string

Value is "Rate updated successfully.".

object

The updated rate record.

curl -X PUT https://your-instance.laracopilot.com/api/rates/2 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -b cookies.txt \
  -d '{
    "tenant_id": 1,
    "prefix": "44",
    "destination": "UK Landline",
    "cost_per_minute": 0.0300,
    "billing_increment": 30,
    "status": "active"
  }'

{
  "message": "Rate updated successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "prefix": "44",
    "destination": "UK Landline",
    "cost_per_minute": "0.0300",
    "billing_increment": 30,
    "status": "active",
    "created_at": "2025-04-22T11:00:00.000000Z",
    "updated_at": "2025-04-22T12:00:00.000000Z"
  }
}

DELETE /api/rates/

Permanently deletes the specified rate. Path parameters

integer

required

The numeric ID of the rate to delete.

string

Value is "Rate deleted successfully.".

curl -X DELETE https://your-instance.laracopilot.com/api/rates/2 \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Rate deleted successfully."
}

Authentication

Resources

Messaging

Rates API — Per-Tenant Billing Rate Plan Management

GET /api/rates

POST /api/rates

GET /api/rates/

PUT /api/rates/

DELETE /api/rates/

​GET /api/rates

​POST /api/rates

​GET /api/rates/

​PUT /api/rates/

​DELETE /api/rates/

GET /api/rates

POST /api/rates

GET /api/rates/

PUT /api/rates/

DELETE /api/rates/