v1

latestOpenAPI 3.0.0Use under Unicorn2026-07-14272948.7 KB
Package

Update existing package by its ID

put/api/Package

Request body

addonFeenumber

sum of addon fees. incoming values for this filed will ignore.

applyForAllGymsboolean

Boolean value to indicate wheather package is available in all the gyms.

bindingPeriodinteger

Range of period a member is bound to the contract if he/she choose this package.

createdDatestring date-time

Package created DateTime.

createdUserstring nullable

Package created user.

descriptionstring nullable

Common descriptions about package.If there are more instructions can be stored as comma separated values.

endDatestring date-time

End date of the package.After that package is not valid for use.

expireInMonthsinteger

No of months the fixed package is valid for sale

featuresstring nullable

What are the facilities, features available for package.ex:- wifi, ACm etc.Can be stored as comma seperated values.

freeMonthsinteger

No of months gym member can come without payments.

instructionsToGymUsersstring nullable

Instruction to the gym members relevant to the package. If there are more instructions can be stored as comma seperated values.

instructionsToWebUsersstring nullable

Instruction to the MRM members relevant to the package. If there are more instructions can be stored as comma seperated values.

isActiveboolean

Boolean value to indicate this package is still active or not.

isAtgboolean

Boolean value to indicate ATG transaction from bank is applicable or not.

isAutoRenewboolean

Boolean value to indicate the contract will auto renew after expiration if this package would be chosen.

isFirstMonthFreeboolean

Boolean value to indicate if the first month charges is free.

isRegistrationFeeboolean

Boolean value to indicate this package has registration fee or not.

isRestAmountboolean

Boolean value to indicate rest amount is applicable or not.

isShownInMobileboolean

Boolean value to indicate package is visible in Mobile App or not.

isSponsorPackageboolean

Boolean value to indicate package can be sponsored or not by other party.

maximumGiveAwayRestAmountnumber

If a member join the gym middle of a month via this package, what is the maximum amount of price can be neglected from payment from the member.

memberCanAddAddOnsboolean

Boolean value to indicate member can add extra addons he wish if he choose this package.

memberCanLeaveWithinFreePeriodboolean

Boolean value to indicate if member can leave from contract within free period if he/she choose this package.

memberCanRemoveAddOnsboolean

Boolean value to indicate member can remove already added addons if he choose this package.

modifiedDatestring date-time

Package last modified DateTime.

modifiedUserstring nullable

Package last modified user.

monthlyFeenumber

Monthly installment fee if package is not fixed visit. addition of the servicefee and addon fees divided by binding period. read only

nextPackageNumberinteger

Next Package the contract continue after the binding period of this package.

numberOfInstallmentsinteger

Maximum Number of installment a member can divide the package price/cost to pay.

numberOfVisitsinteger

If package is fixed visit type, then how many visits are available for this package.

packageIdinteger
packageNamestring required
packageNumberstring nullable
packageTypestring required

Package type can be either fixed visit or unlimited.

perVisitPricenumber

Cost/Price of the single visit to gym.

registrationFeenumber required

Registartion fee for the package at a gym. read only

serviceFeenumber required

total Service charge of the package for entire period.

shownInWebboolean

Boolean value to show this package in MRM system or not.

startDatestring date-time

Start date of the package.

tagsstring nullable

Comma separated string values in case of need of maintain some labels kind of stuff relevant to the package.

totalPricenumber

total price for the package including Addon fees, service fee and registration fee. incoming values for this field will ignore.

Response

messageId that can use to get the status of import later on.!

isErrorboolean
messagestring nullable
{"stackTrail":"components:schemas:DefaultResponseDTOOfStatusDTO:properties:responseException","oasType":"schema","type":"unknown","nullable":true}