Skip to main content
GET
/
api
/
v1
/
subscription_details
/
all
/
paginated
Get paginated subscription details with filters
curl --request GET \
  --url https://api.raul.ugps.io/api/v1/subscription_details/all/paginated \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "subscription_detail_id": "<string>",
      "subscription_plan_id": {},
      "gps_detail_id": {},
      "client_id": {},
      "vehicle_id": {},
      "fecha_inicio": {},
      "fecha_termino": {},
      "subscription_status_id": {},
      "subscription_frequency_id": {},
      "creation_date": {},
      "update_date": {},
      "subscriptionPlan": {
        "id": 123,
        "subscription_currency_id": 123,
        "name": {},
        "currency_name": {},
        "currency_value": {},
        "description": {}
      },
      "subscriptionStatus": {
        "subscription_status_id": 123,
        "name": "<string>"
      },
      "subscriptionFrequency": {
        "id": 123,
        "name": "<string>"
      },
      "vehicle": {
        "id": "<string>",
        "license_plate": {},
        "name": {},
        "model": {},
        "brand": {}
      },
      "child_client_id": {},
      "childClient": {
        "client_id": "<string>",
        "client_name": "<string>"
      }
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

page
number
default:1
Required range: x >= 1
limit
number
default:50
Required range: 1 <= x <= 100
sort
string
default:update_date
order
enum<string>
default:desc
Available options:
asc,
desc
client_id
string

Filter by client ID

subscription_status_id
number

Filter by subscription status ID

subscription_plan_id
number

Filter by subscription plan ID

date_from
string

Filter from date (ISO 8601)

date_to
string

Filter to date (ISO 8601)

is_expired
boolean

Filter by expiration status

Search in client name, GPS details

child_client_id
string

Filter by child client ID (multi-tenant)

Response

200 - application/json

Paginated list of subscriptions

data
object[]
required
pagination
object
required