Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Table of contents

Before using this, please refer to Account API functions for login and API explanations.


Get member subscription history

Changes the logged in users' email address

GET /user/history/subscriptions

Account privilege restriction:

  • Root
  • Club manager
  • Administrator / Reception
  • Member

Request

 Click here to expand...


Request

Endpoint: /user/history/subscriptions

Method: GET

Only logged in: YES

Account privilege restriction:
  • Root
  • Club manager
  • Administrator / Reception
  • Member

Headers:

 Click here to expand...
Header nameValue
X-Requested-With
XMLHttpRequest
X-Auth-TokenToken obtained from Login endpoint

Parameters:

 Click here to expand...
ParameterRequiredTypeDescription
user_id
NO
String

User id for which to get the information

Ignored if privilege is member and will only return data for current logged in member

sidx

NO

Default: name

String

Sort index for which to sort the records:

  • name - Name of the subscription
  • start_date - Subscription start date
  • end_date - Subscription end date
  • price - Subscription price
  • type - Subscription type
  • checkins - Subscription check-ins number
  • entrances - Subscription group class entrances number
  • invites - Subscription invites number
  • min_hour - Subscription minimum access hour
  • max_hour - Subscription maximum access hour
  • limited_stock - Subscription limited stock
  • availability - Subscription availability
sord

NO

Default: asc

String

Sort order:

  • asc- Ascending
  • desc - Descending
limit

NO

Default: 10

IntegerNumber of records to fetch
page

NO

Default: 1

IntegerPage number
subscription_stateNOInteger

State of the subscription:

  • 0 - Expired
  • 1 - Available
  • 2 - Not started yet
no_limitNOBooleanIf set, it will ignore limit and page parameters and will fetch ALL records
  • No labels