List all memberships of a guest

get https://api.zenoti.com/v1/guests/{guest_id}/memberships?center_id={center_id}

This API helps you to retrieve the membership history of the respective guest. You must specify the unique identifier of the guest as guest_id in the request. If you want to breakdown the list of memberships by their status, you must pass the expand parameter is_active. If you are using api_key to retrieve the data, it is mandatory to specify the center_id details in the request.

Response Details

Name	Type	Description
guest_memberships	object	Object containing a list of all the memberships of the guest.
UserMemberships	object	Object containing details of all the guest's memberships.
freeze_reasons	object	Object containing the details of freeze reasons of the guest's membership.
cancel_reasons	object	Object containing the details of the cancel reasons of the guest's membership.

guest_membership object

Name	Type	Description
user_membership_id	guid	Unique identifier of the user membership
status	enum	Current status of the membership: Active = 1, InActive = 2, Frozen = 3, Cancelled = 4, Expired = 5, Closed = 6, NotStarted = 7, Suspended = 8, Refund = 9, Deleted = 10, Failed = 12, Default = -1
is_refunded	bool	Refund status of the membership
recurrence_status	enum	Recurrence status of the membership: Active = 1, InActive = 2, Frozen = 3, Cancelled = 4, Expired = 5, Closed = 6, NotStarted = 7, Suspended = 8, Refund = 9, Deleted = 10, Failed = 12, Default = -1
redeemable	bool?	Whether the membership is redeemable
membership	object	Membership object containing type of the membership: All = -1, Non Recurring = 0, Recurring = 1, Setup = 2
invoice	object	Invoice object containing Id, invoice no, status and receipt no
expiry_date	datetime	Date on which the membership will expire
next_collection_date	datetime	Date on which you must collect the membership fees
credit_balance	object	Balance details of the membership containing service, product and other balances with comments
credit_amount	int	The credit amount available in the membership
services	object	Services object containing details such as Id, name, balance, expired, frequency.
products	object	Credit amount details of the membership containing total, service, product and other amounts
redemption_setting_details	string	Redemption setting details containing totalpayment, initial recognized revenue etc
invoice_center_id	guid?	Unique Identifier of the Invoice Center
restrict_cross_center_redemption	bool?	Whether Cross Center Redemption is allowed
next_collection_amount	decimal	Denotes the amount that will be collected next as part of the guest's membership.
freeze_fee_amount	decimal	Denotes the amount of the freeze fee on the guest's membership.
freeze_fee_next_collection_date	datetime	Denotes the collection date of the freeze fee.
cancel_fee_amount	decimal	Denotes the amount of the cancel fee charged on the guest's membership.
cancel_fee_next_collection_date	datetime	Denotes the collection date of the cancel fee.
upgrade_options	object	Details containing id, name, is_upgrade, price, is_annual_fee_enabled, annual_fee, can_prorate
downgrade_options	object	Details containing id, name, is_upgrade, price, is_annual_fee_enabled, annual_fee, can_prorate
historical_invoices	object	Containing sale_date, sale_by, price, discount, taxes, price_paid, payment_type, promotion, invoice details
credit_amount	object

usermemberships Object

Name	Type	Description
UserMembershipId	guid	Unique identifier of the membership
Name	string	Name of the guest's membership.
ServiceCreditAmount	decimal	Credit amount remaining for the services.
ServiceCreditAmountUsed	decimal	Credit amount used up in the memberships.
ServiceCreditAmountLeft	decimal	Amount left in the memberships.
ServiceCreditAmountBalance	decimal	Balance left for the services.
MembershipId	guid	Identifier of the membership .
MembershipNumber	string	Number of the membership.
MembershipInvoiceNo	string	Invoice number raised for the purchase of the membership.
MembershipType	int	Type of the membership purchased by the guest.
MembershipDuration	string	Duration of the membership.
SetupFee	decimal	Set up fee incurred by the guest for the membership.
RecurringFee	decimal	Recurring fee for the membership.
MembershipPrice	decimal	Price of the membership purchased by the guest.
ValidFrom	datetime	Validity of the membership.
NoOfCollections	int	Collections for the membership.
AmountUsed	decimal	Amount redeemed in the membership.
FirstCollectionDate	datetime	Denotes the first collection date for the membership.
NextCollectionDate	datetime	Denotes the next collection date for the membership.
ExpiryDate	datetime	Expiry date of the membership.
MembershipSoldBy	string	Employee name who sold the membership to the guest.
MembershipPaymentMethod	sting	Payment method used for the purchase of the membership.
MembershipLockInPeriod	sting	Lock in period of the membership.
BenefitName	string	Name of the benefits provided in the membership.
BenefitServiceBalance	int	Balance of the membership service benefits.
BenefitServiceBalanceV2	double	Balance of the membership service benefits.
ExpirationDays	int	Expiry limit for the membership.
Quantity	int	Quantity purchased by the guest.
Used	double	Benefits used by the guest.
Transferred	int	Benefits transferred by the guest.
EnableServiceCreditTransfer	bool	Denotes if the service credit transfer is enabled.
AllowDirectBooking	bool	Denotes if direct booking is allowed.
BenefitServiceId	guid	Service id of the benefit.
Frequency	string	Frequence for the services in the membership.
Notes	string	Notes pertaining the guest's membership.
HasEquivalents	bool	Denotes if the membership as any equivalents.
AddOnCredits	int	Credits for the add ons.
AddOnCreditsV2	double	Credits for the add ons
SaleCenterName	string	Center where the membership was sold.
RestrictCrossCenterRedemption	bool	Denotes if there is a restriction on the cross center redemption for membership.
CatalogDisplayName	string	Guest display name as per the catalog.
MembershipStatus	string	Status of the membership.
UserTermsandConditions	string	The terms and conditions of the membership.
HasMembershipDigitalForm	bool	Denotes if the guest has filed the membership forms.
HasFilledMembershipForms	bool	Denotes if the guest has filed the membership forms.
MembershipImage	object	Image of the membership.
GuestPassType	int	Denotes the type of the Guest Pass.
GuestPassBalance	int	Denotes the balance in the Guest Pass
MembershipStatusEnum	enum	Denotes the current status of the guest's membership
RecurrenceStatus	enum	Denotes the current status of the guest's recurring membership.
IsFreezeFeeReasonEnabled	bool	Denotes if the freeze reason is enabled.
GroupUserMembershipId	guid	Unique identifier of the group membership.
NextCollectionAmount	object	Collection amount of the next installement.

GuestMembershipSummaryViewModel

Json Property	Data Type	Description
user_membership_id	Guid?	Unique identifier for the user membership.
group_user_membership_id	Guid?	Unique identifier for the group user membership.
status	MembershipStatusView	View of the membership status.
is_refunded	bool	Indicates whether the membership is refunded.
recurrence_status	MembershipRecurrenceStatusView	View of the recurrence status.
redeemable	bool?	Indicates whether the membership is redeemable.
membership	MembershipBasicWithTypeCodeAndFreezeFeeReason	Basic membership details.
invoice	GuestMembershipInvoiceDetails	Details of the guest membership invoice.
expiry_date	DateTime?	Date when the membership expires.
next_collection_date	DateTime?	Date of the next collection.
next_collection_amount	Decimal	Amount of the next collection.
cancel_fee_next_collection_date	DateTime?	Date for the next collection of cancellation fee.
membership_price	decimal?	Price of the membership.
start_date	DateTime?	Start date of the membership.
first_collection_date	DateTime?	Date of the first collection.
benefit_service_balance	int?	Balance of benefit services.
setup_fee	decimal?	Setup fee for the membership.
valid_from	DateTime?	Validity start date.
allow_other_centers_for_action_on_invoices	bool?	Indicates whether actions on invoices are allowed for other centers.
credit_balance	GuestMembershipCreditBalanceDetails	Details of the credit balance.
credit_amount	GuestMembershipCreditAmountDetails	Details of the credit amount.
services	List<GuestMembershipServiceBalanceDetails>	List of service balance details.
products	List<GuestMembershipProductBenefitDetails>	List of product benefit details.
redemption_setting_details	GuestMembershipSettingDetailsForRedemption	Redemption setting details.
invoice_center_id	Guid?	Unique identifier for the invoice center.
restrict_cross_center_redemption	bool?	Indicates whether cross-center redemption is restricted.
upgrade_options	List<MembershipUpgradeDownGradeOptionDetails>	List of upgrade options.
downgrade_options	List<MembershipUpgradeDownGradeOptionDetails>	List of downgrade options.
historical_invoices	List<MembershipHistoricalInvoiceDetails>	List of historical invoices.
guestpass_type	string	Type of the guest pass.
guestpass_total	int	Total count of guest passes.
guestpass_balance	int	Remaining count of guest passes.
is_addon_member	bool	Indicates whether the member is an addon member.
member_code	string	Code associated with the member.
html_benefits	string	HTML representation of the benefits.
member_since	DateTime	Date when the member joined.

MembershipBasicWithTypeCodeAndFreezeFeeReason

Json Property	Data Type	Description
MembershipType	string	Type of the membership.
MembershipCode	string	Code associated with the membership.
FreezeFeeReason	string	Reason for the freeze fee.

GuestMembershipInvoiceDetails

Json Property	Data Type	Description
InvoiceId	Guid	Unique identifier for the invoice.
InvoiceDate	DateTime	Date of the invoice.
TotalAmount	Decimal	Total amount of the invoice.
PaidAmount	Decimal	Amount paid for the invoice.
DueAmount	Decimal	Amount due for the invoice.
InvoiceStatus	string	Status of the invoice.
BillingAddress	Address	Billing address details.
PaymentDetails	PaymentInformation	Payment details for the invoice.

MembershipRecurringDetailsDates

Json Property	Data Type	Description
RecurringStartDate	DateTime	Start date of recurring payments.
RecurringEndDate	DateTime	End date of recurring payments.
NextRecurringCollection	DateTime	Next recurring payment collection.

Language

Credentials

Header

Click Try It! to start a request and see the response here!