Follow the question structure recommended by Dev Bot before submitting your integration questions.
NOTE. Available for use with branch access key and also with General ADM access key.
| Parameter | Type | Required | Description |
|---|---|---|---|
| idMemberMembership | int32 | Yes | Unique ID of the (MemberMembership) to be queried. |
| Field | Type | Description |
|---|---|---|
| idMember | int32 | ID of the member. |
| idMembership | int32 | ID of the plan/membership. |
| idMemberMembership | int32 | Unique identifier of the member's link with the membership. |
| idMemberMembershipRenewed | int32 | ID of the renewed membership (if any). |
| numMembers | int32 | Number of associated members (principal + dependents). |
| startDate | date-time | Start date of the membership. |
| endDate | date-time | End date of the membership. |
| name | string | Name of the plan/membership. |
| cancelDate | date-time | Effective cancellation date. |
| cancelDateOn | date-time | Scheduled cancellation date. |
| cancelCreationDate | date-time | Date when the cancellation request was created. |
| membershipStatus | string | Current status of the membership. |
| valueNextMonth | number | Value of the next installment. |
| nextCharge | date-time | Date of the next charge. |
| nextDateSuspension | date-time | Next registered suspension date. |
| idSale | int32 | ID of the sale associated with the membership. |
| saleDate | date-time | Sale date. |
| contractPrinting | string | Content or URL for printing the contract. |
| freezes | array | List of freezes of the membership. See object freezes[]. |
| idCategoryMembership | int32 | ID of the membership category. |
| numberSuspensionTimes | int32 | Total number of suspensions already made. |
| maxSuspensionDays | int32 | Maximum days allowed for suspension. |
| minimumSuspensionDays | int32 | Minimum days allowed for suspension. |
| disponibleSuspensionDays | int32 | Days available for suspension. |
| disponibleSuspensionTimes | int32 | Remaining number of allowed suspensions. |
| daysLeftToFreeze | int32 | Days remaining for freezing. |
| loyaltyEndDate | date-time | End date of the loyalty period. |
| assessmentEndDate | date-time | Expiration date of the physical assessment. |
| acceptanceDate | date-time | Date of acceptance/activation of the contract. |
| flAllowLocker | boolean | Indicates if the member can use the locker. |
| flAdditionalMembership | boolean | Indicates if the membership is additional. |
| bioimpedanceAmount | number | Number of available bioimpedance assessments. |
| signedTerms | boolean | Indicates if the terms have been signed. |
| originalValue | number | Original value of the membership at the time of sale. |
| allowLesMills | boolean | Indicates if the plan includes Les Mills classes. |
| allowsCancellationByApp | boolean | If cancellation via the app is allowed. |
| contractSigningUrl | string | URL for digital signature available for contract acceptance. |
| limitless | boolean | Indicates if the membership is unlimited. |
| weeklyLimit | int32 | Weekly usage/session limit. |
| concludedSessions | int32 | Total completed sessions. |
| pendingSessions | int32 | Total pending sessions. |
| scheduledSessions | int32 | Number of scheduled sessions. |
| pendingRepositions | int32 | Pending reposition sessions. |
| repositionsTotal | int32 | Total number of available repositions. |
| bonusSessions | int32 | Total available bonus sessions. |
| sessions | array | List of sessions linked to the membership. See object sessions[]. |
freezes array of objects| Field | Type | Description |
|---|---|---|
| startSuspend | date-time | Start date of the suspension. |
| endSuspend | date-time | End date of the suspension. |
| unlockDate | date-time | Date when the membership will be reactivated. |
| idEmployee | int32 | ID of the staff member who registered the freeze. |
| reason | string | Reason provided for the suspension. |
| flUseMembershipFreezeDays | boolean | If it uses the days allowed by the membership. |
| daysFreeze | int32 | Number of frozen days. |
| idFreeze | int32 | ID of the freeze record. |
sessions array of objects| Field | Type | Description |
|---|---|---|
| idSession | int32 | ID of the session. |
| expirationDate | date-time | Expiration date of the session. |
| flBonusSession | boolean | Indicates if the session is bonus. |