Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Table of contents

Table of Contents



Info

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

Info
iconfalse

Status
colourYellow
titleGET
 /user/history/subscriptions


Warning

Account privilege restriction:

  • Root
  • Club manager
  • Administrator / Reception
  • Member


Request

Expand


Request

Endpoint: /user/history/subscriptions

Method:

Status
colourYellow
titleGET

Only logged in:

Status
colourGreen
titleYES

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

Headers:

Expand


Header nameValue
X-Requested-With
XMLHttpRequest
X-Auth-TokenToken obtained from Login endpoint



Parameters:

Expand


ParameterRequiredTypeDescription
user_id
Status
subtletrue
colourRed
titleNO
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

Status
subtletrue
colourRed
titleNO

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

Status
subtletrue
colourRed
titleNO

Default: asc

String

Sort order:

  • asc- Ascending
  • desc - Descending
limit

Status
subtletrue
colourRed
titleNO

Default: 10

IntegerNumber of records to fetch
page

Status
subtletrue
colourRed
titleNO

Default: 1

IntegerPage number
subscription_state
Status
subtletrue
colourRed
titleNO
Integer

State of the subscription:

  • 0 - Expired
  • 1 - Available
  • 2 - Not started yet
no_limit
Status
subtletrue
colourRed
titleNO
BooleanIf set, it will ignore limit and page parameters and will fetch ALL records