Skip to main content
GET
/
v1
/
billing-groups
List billing groups
curl --request GET \
  --url https://api-eu.flexportal.io/v1/billing-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Tenant-ID: <tenant-id>'
{
  "success": true,
  "billingGroups": [
    {
      "billingGroupId": "<string>",
      "tenantId": "<string>",
      "customerId": "<string>",
      "groupName": "<string>",
      "billingDay": 14,
      "totalMonthlyAmount": 1,
      "currency": "<string>",
      "status": "active",
      "createdBy": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "rentalIds": [],
      "activeRentalCount": 0,
      "notes": "<string>"
    }
  ],
  "count": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Query Parameters

limit
string

Items per page (default: 50, max: 100)

startAfter
string

Cursor for pagination

customerId
string

Filter by customer ID

status
string

Filter by status (active, inactive)

Response

200 - application/json

List of billing groups

success
enum<boolean>
required
Available options:
true,
false
billingGroups
object[]
required
count
number
required
hasMore
boolean
required
nextCursor
string | null
required