Restaurant - Subscription

Get all subscriptions with pagination and filtering

GET

/restaurant/subscriptions

const url = 'https://api.inspow.tech/api/v1/restaurant/subscriptions?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.inspow.tech/api/v1/restaurant/subscriptions?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D'

Parameters

Query Parameters

limit

required

number

Example

Number of items to return

offset

required

number

Example

Number of items to skip

sortBy

string

Example

createdAt

Field to sort the results (Deprecated, use sort instead)

sortOrder

string

Example

asc

Sort direction, either asc or desc (Deprecated, use sort instead)

searchQuery

string

Query search to filter items

query

string

Query to filter items in MongoDB query format

sort

string

Example

{"lastName": -1, "email": 1}

JSON string specifying sorting fields and order (e.g. { “lastName”: -1, “email”: 1 })

Responses

200

application/json

object

user

required

The ID of the user who pays and receives notifications.

MongoId

beneficiary

required

The ID of the beneficiary (hijo). Omitir para suscripción individual.

object

plan

required

The ID of the plan contratado.

object

status

required

Current status of the subscription.

string

Allowed values: draft pending_parent_confirmation pending_payment active suspended cancelled expired

startDate

required

Subscription start date.

string format: date-time

endDate

required

Subscription end date.

string format: date-time

autoRenew

If true, la suscripción se renueva automáticamente.

boolean

default: true

requireParentConfirm

If true, se requiere confirmación parental antes de activar la suscripción.

boolean

createdBy

required

The ID of the user who created this record.

MongoId

updatedBy

required

The ID of the user who last updated this record.

MongoId

createdAt

required

The timestamp when the attendance record was created.

string format: date-time

updatedAt

required

The timestamp when the attendance record was last updated.

string format: date-time

Example

{
  "user": "645cc3d3f8a9c9a2b88a22c4",
  "beneficiary": "645cc3d3f8a9c9a2b88a22d7",
  "plan": "645cc3d3f8a9c9a2b88a22e3",
  "status": "draft",
  "startDate": "2025-05-01T00:00:00.000Z",
  "endDate": "2025-05-31T23:59:59.999Z",
  "autoRenew": true,
  "requireParentConfirm": false,
  "createdBy": "645cc3d3f8a9c9a2b88a22c4",
  "updatedBy": "645cc3d3f8a9c9a2b88a22c5",
  "createdAt": "2023-11-25T00:00:00.000Z",
  "updatedAt": "2023-11-26T00:00:00.000Z"
}