> For the complete documentation index, see [llms.txt](https://docs.podplay.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.podplay.app/api/memberships.md).

# Memberships

Membership plans, subscriptions, enrollments, and prepaid packages.

## GET /membership/jobs/{jobId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/membership/jobs/{jobId}":{"get":{"operationId":"MembershipJobsController_getJob","parameters":[{"name":"jobId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Memberships"]}}}}
```

## POST /membership/jobs/capture

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipJobCaptureDto":{"type":"object","properties":{"type":{"type":"string","writeOnly":true},"date":{"format":"date-time","type":"string"},"job":{"type":"object","readOnly":true},"users":{"readOnly":true,"allOf":[{"$ref":"#/components/schemas/UserMembershipSubscriptionSummaryCollectionDto"}]},"_links":{"type":"object"}},"required":["type","job","users","_links"]},"UserMembershipSubscriptionSummaryCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserMembershipSubscriptionSummaryDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"UserMembershipSubscriptionSummaryDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"user":{"type":"object","readOnly":true},"amount":{"type":"number","readOnly":true},"_links":{"type":"object","readOnly":true}},"required":["id","user","amount","_links"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/membership/jobs/capture":{"post":{"operationId":"MembershipJobsController_capture","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipJobCaptureDto"}}}},"responses":{"201":{"description":""}},"tags":["Memberships"]}}}}
```

## GET /memberships

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipDto"}},"_pagination":{"$ref":"#/components/schemas/PaginationDto"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_pagination","_links"]},"MembershipDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"membershipPlan":{"$ref":"#/components/schemas/MembershipPlanDto"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SOLD_OUT"]},"yearlyPrice":{"type":"number"},"monthlyPrice":{"type":"number"},"monthlyDisplayPrice":{"type":"string"},"initiationFeeMonthly":{"type":"number"},"initiationFeeYearly":{"type":"number"},"additionalMemberFee":{"type":"number"},"additionalMembersCap":{"type":"number"},"bookingHorizonDays":{"type":"number","description":"If specified, overrides the tenant setting `company.bookingHorizonDays.members`"},"benefits":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"},"showSubscriptionDetails":{"type":"boolean"},"allowPublicCancellation":{"type":"boolean"},"isGroupMembership":{"type":"boolean"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"tags":{"type":"string","enum":["MOST_POPULAR","LIMITED_AVAILABILITY"]},"settings":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"},"subscriptionsCount":{"type":"number","readOnly":true,"nullable":true},"hasOrHadMembers":{"type":"boolean","readOnly":true},"slug":{"type":"string"},"taxRegionId":{"type":"string","readOnly":true},"allowedChargeTypes":{"type":"array","items":{"type":"string","enum":["YEARLY","MONTHLY","NON_RECURRING"]}},"contactEmail":{"type":"string"},"oneTimePriceOptions":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"},"priceChangeScope":{"type":"string","enum":["ALL_CURRENT","NEW_ONLY"],"description":"Scope for price changes: ALL_CURRENT updates existing members, NEW_ONLY applies only to new subscriptions"},"presalesEndDateChangeScope":{"type":"string","enum":["ADJUST_SUBSCRIPTIONS","NO_CHANGE"],"description":"Scope for presales end date changes: ADJUST_SUBSCRIPTIONS updates existing subscribers, NO_CHANGE leaves subscriptions unchanged"},"adjustMonthlyGrantDates":{"type":"boolean","description":"When true and presalesEndDateChangeScope is ADJUST_SUBSCRIPTIONS, also adjusts nextGrantDate for monthly subscriptions"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","description","type","membershipPlan","status","benefits","areas","membershipAreas","tags","settings","slug","allowedChargeTypes","errors","_links"]},"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]},"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]},"PaginationDto":{"type":"object","properties":{"page":{"type":"number"},"ipp":{"type":"number"},"count":{"type":"number"},"total":{"type":"number"}},"required":["page","ipp","count","total"]}}},"paths":{"/memberships":{"get":{"operationId":"MembershipController_find","parameters":[{"name":"includeUnlisted","required":false,"in":"query","description":"Include unlisted memberships, based on permissions.","schema":{"type":"boolean"}},{"name":"slug","required":false,"in":"query","description":"Filter by membership slug.","schema":{"type":"string"}},{"name":"page","required":true,"in":"query","schema":{"type":"number"}},{"name":"ipp","required":true,"in":"query","schema":{"type":"number"}},{"name":"membershipId","required":false,"in":"query","explode":true,"description":"Filter memberships by membership id. Supports multiple.","schema":{"type":"array","items":{"type":"string"}}},{"name":"areaId","required":false,"in":"query","explode":true,"description":"Filter memberships by area id. Supports multiple.","schema":{"type":"array","items":{"type":"string"}}},{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returns a `MembershipCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipCollectionDto"}}}}},"tags":["Memberships"]}}}}
```

## POST /memberships

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"membershipPlan":{"$ref":"#/components/schemas/MembershipPlanDto"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SOLD_OUT"]},"yearlyPrice":{"type":"number"},"monthlyPrice":{"type":"number"},"monthlyDisplayPrice":{"type":"string"},"initiationFeeMonthly":{"type":"number"},"initiationFeeYearly":{"type":"number"},"additionalMemberFee":{"type":"number"},"additionalMembersCap":{"type":"number"},"bookingHorizonDays":{"type":"number","description":"If specified, overrides the tenant setting `company.bookingHorizonDays.members`"},"benefits":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"},"showSubscriptionDetails":{"type":"boolean"},"allowPublicCancellation":{"type":"boolean"},"isGroupMembership":{"type":"boolean"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"tags":{"type":"string","enum":["MOST_POPULAR","LIMITED_AVAILABILITY"]},"settings":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"},"subscriptionsCount":{"type":"number","readOnly":true,"nullable":true},"hasOrHadMembers":{"type":"boolean","readOnly":true},"slug":{"type":"string"},"taxRegionId":{"type":"string","readOnly":true},"allowedChargeTypes":{"type":"array","items":{"type":"string","enum":["YEARLY","MONTHLY","NON_RECURRING"]}},"contactEmail":{"type":"string"},"oneTimePriceOptions":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"},"priceChangeScope":{"type":"string","enum":["ALL_CURRENT","NEW_ONLY"],"description":"Scope for price changes: ALL_CURRENT updates existing members, NEW_ONLY applies only to new subscriptions"},"presalesEndDateChangeScope":{"type":"string","enum":["ADJUST_SUBSCRIPTIONS","NO_CHANGE"],"description":"Scope for presales end date changes: ADJUST_SUBSCRIPTIONS updates existing subscribers, NO_CHANGE leaves subscriptions unchanged"},"adjustMonthlyGrantDates":{"type":"boolean","description":"When true and presalesEndDateChangeScope is ADJUST_SUBSCRIPTIONS, also adjusts nextGrantDate for monthly subscriptions"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","description","type","membershipPlan","status","benefits","areas","membershipAreas","tags","settings","slug","allowedChargeTypes","errors","_links"]},"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]},"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/memberships":{"post":{"operationId":"MembershipController_createMembership","parameters":[],"requestBody":{"required":true,"description":"The `Membership` to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipDto"}}}},"responses":{"201":{"description":"Returns a `Membership`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipDto"}}}},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.<br/><br>Possible error codes are:<br>`M0001`: Name must be set.<br>`M0002`: Status must be set.<br>`M0003`: Membership Plan must be set.<br>`M0004`: Monthly Price must be set.<br>`M0005`: Yearly Price must be set.<br>`M0006`: Membership Areas must be set.<br>`M0007`: Membership name already exists.<br>`M0008`: Membership slug already exists.<br>`M0009`: Membership slug must be set.<br>`M0010`: Invalid slug format. Use lowercase and hyphens, e.g., \"this-is-an-example\".<br>`M0011`: Area Liability Waiver agreement is missing for some areas. You must add an agreement for each area prior to activating the membership.<br>`M0012`: One-time pricing options must be set for non-recurring memberships.<br>`M0013`: Pause minimum weeks must be set and greater than 0 when pause is enabled.<br>`M0014`: Pause maximum weeks must be set and greater than 0 when pause is enabled.<br>`M0015`: Pause minimum weeks must be less than or equal to pause maximum weeks.<br>`M0016`: Pause fee must be equal or greater than 0.<br>`M0017`: Pause minimum weeks for monthly must be set and greater than 0 when monthly pause is enabled.<br>`M0018`: Pause maximum weeks for monthly must be set and greater than 0 when monthly pause is enabled.<br>`M0019`: Pause minimum weeks for monthly must be less than or equal to pause maximum weeks for monthly.<br>`M0020`: Pause minimum weeks for yearly must be set and greater than 0 when yearly pause is enabled.<br>`M0021`: Pause maximum weeks for yearly must be set and greater than 0 when yearly pause is enabled.<br>`M0022`: Pause minimum weeks for yearly must be less than or equal to pause maximum weeks for yearly.<br>`M0023`: Presales end date changed. Confirm to adjust next charge dates for existing subscribers."}},"tags":["Memberships"]}}}}
```

## GET /memberships/{membershipId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"membershipPlan":{"$ref":"#/components/schemas/MembershipPlanDto"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SOLD_OUT"]},"yearlyPrice":{"type":"number"},"monthlyPrice":{"type":"number"},"monthlyDisplayPrice":{"type":"string"},"initiationFeeMonthly":{"type":"number"},"initiationFeeYearly":{"type":"number"},"additionalMemberFee":{"type":"number"},"additionalMembersCap":{"type":"number"},"bookingHorizonDays":{"type":"number","description":"If specified, overrides the tenant setting `company.bookingHorizonDays.members`"},"benefits":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"},"showSubscriptionDetails":{"type":"boolean"},"allowPublicCancellation":{"type":"boolean"},"isGroupMembership":{"type":"boolean"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"tags":{"type":"string","enum":["MOST_POPULAR","LIMITED_AVAILABILITY"]},"settings":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"},"subscriptionsCount":{"type":"number","readOnly":true,"nullable":true},"hasOrHadMembers":{"type":"boolean","readOnly":true},"slug":{"type":"string"},"taxRegionId":{"type":"string","readOnly":true},"allowedChargeTypes":{"type":"array","items":{"type":"string","enum":["YEARLY","MONTHLY","NON_RECURRING"]}},"contactEmail":{"type":"string"},"oneTimePriceOptions":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"},"priceChangeScope":{"type":"string","enum":["ALL_CURRENT","NEW_ONLY"],"description":"Scope for price changes: ALL_CURRENT updates existing members, NEW_ONLY applies only to new subscriptions"},"presalesEndDateChangeScope":{"type":"string","enum":["ADJUST_SUBSCRIPTIONS","NO_CHANGE"],"description":"Scope for presales end date changes: ADJUST_SUBSCRIPTIONS updates existing subscribers, NO_CHANGE leaves subscriptions unchanged"},"adjustMonthlyGrantDates":{"type":"boolean","description":"When true and presalesEndDateChangeScope is ADJUST_SUBSCRIPTIONS, also adjusts nextGrantDate for monthly subscriptions"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","description","type","membershipPlan","status","benefits","areas","membershipAreas","tags","settings","slug","allowedChargeTypes","errors","_links"]},"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]},"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/memberships/{membershipId}":{"get":{"operationId":"MembershipController_findOne","parameters":[{"name":"expand","required":false,"in":"query","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `Membership`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipDto"}}}}},"tags":["Memberships"]}}}}
```

## DELETE /memberships/{membershipId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"membershipPlan":{"$ref":"#/components/schemas/MembershipPlanDto"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SOLD_OUT"]},"yearlyPrice":{"type":"number"},"monthlyPrice":{"type":"number"},"monthlyDisplayPrice":{"type":"string"},"initiationFeeMonthly":{"type":"number"},"initiationFeeYearly":{"type":"number"},"additionalMemberFee":{"type":"number"},"additionalMembersCap":{"type":"number"},"bookingHorizonDays":{"type":"number","description":"If specified, overrides the tenant setting `company.bookingHorizonDays.members`"},"benefits":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"},"showSubscriptionDetails":{"type":"boolean"},"allowPublicCancellation":{"type":"boolean"},"isGroupMembership":{"type":"boolean"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"tags":{"type":"string","enum":["MOST_POPULAR","LIMITED_AVAILABILITY"]},"settings":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"},"subscriptionsCount":{"type":"number","readOnly":true,"nullable":true},"hasOrHadMembers":{"type":"boolean","readOnly":true},"slug":{"type":"string"},"taxRegionId":{"type":"string","readOnly":true},"allowedChargeTypes":{"type":"array","items":{"type":"string","enum":["YEARLY","MONTHLY","NON_RECURRING"]}},"contactEmail":{"type":"string"},"oneTimePriceOptions":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"},"priceChangeScope":{"type":"string","enum":["ALL_CURRENT","NEW_ONLY"],"description":"Scope for price changes: ALL_CURRENT updates existing members, NEW_ONLY applies only to new subscriptions"},"presalesEndDateChangeScope":{"type":"string","enum":["ADJUST_SUBSCRIPTIONS","NO_CHANGE"],"description":"Scope for presales end date changes: ADJUST_SUBSCRIPTIONS updates existing subscribers, NO_CHANGE leaves subscriptions unchanged"},"adjustMonthlyGrantDates":{"type":"boolean","description":"When true and presalesEndDateChangeScope is ADJUST_SUBSCRIPTIONS, also adjusts nextGrantDate for monthly subscriptions"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","description","type","membershipPlan","status","benefits","areas","membershipAreas","tags","settings","slug","allowedChargeTypes","errors","_links"]},"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]},"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/memberships/{membershipId}":{"delete":{"operationId":"MembershipController_deleteMembership","parameters":[{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"The `Membership` to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipDto"}}}},"responses":{"200":{"description":"Returns a `Membership`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipDto"}}}},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.<br/><br>Possible error codes are:<br>Membership has or had active subscriptions"}},"tags":["Memberships"]}}}}
```

## PATCH /memberships/{membershipId}

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"membershipPlan":{"$ref":"#/components/schemas/MembershipPlanDto"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SOLD_OUT"]},"yearlyPrice":{"type":"number"},"monthlyPrice":{"type":"number"},"monthlyDisplayPrice":{"type":"string"},"initiationFeeMonthly":{"type":"number"},"initiationFeeYearly":{"type":"number"},"additionalMemberFee":{"type":"number"},"additionalMembersCap":{"type":"number"},"bookingHorizonDays":{"type":"number","description":"If specified, overrides the tenant setting `company.bookingHorizonDays.members`"},"benefits":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"},"showSubscriptionDetails":{"type":"boolean"},"allowPublicCancellation":{"type":"boolean"},"isGroupMembership":{"type":"boolean"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"tags":{"type":"string","enum":["MOST_POPULAR","LIMITED_AVAILABILITY"]},"settings":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"},"subscriptionsCount":{"type":"number","readOnly":true,"nullable":true},"hasOrHadMembers":{"type":"boolean","readOnly":true},"slug":{"type":"string"},"taxRegionId":{"type":"string","readOnly":true},"allowedChargeTypes":{"type":"array","items":{"type":"string","enum":["YEARLY","MONTHLY","NON_RECURRING"]}},"contactEmail":{"type":"string"},"oneTimePriceOptions":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"},"priceChangeScope":{"type":"string","enum":["ALL_CURRENT","NEW_ONLY"],"description":"Scope for price changes: ALL_CURRENT updates existing members, NEW_ONLY applies only to new subscriptions"},"presalesEndDateChangeScope":{"type":"string","enum":["ADJUST_SUBSCRIPTIONS","NO_CHANGE"],"description":"Scope for presales end date changes: ADJUST_SUBSCRIPTIONS updates existing subscribers, NO_CHANGE leaves subscriptions unchanged"},"adjustMonthlyGrantDates":{"type":"boolean","description":"When true and presalesEndDateChangeScope is ADJUST_SUBSCRIPTIONS, also adjusts nextGrantDate for monthly subscriptions"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","description","type","membershipPlan","status","benefits","areas","membershipAreas","tags","settings","slug","allowedChargeTypes","errors","_links"]},"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]},"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/memberships/{membershipId}":{"patch":{"operationId":"MembershipController_updateMembership","parameters":[{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"The `Membership` to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipDto"}}}},"responses":{"200":{"description":"Returns a `Membership`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipDto"}}}},"422":{"description":"Returns an `ErrorDto` in case of validation errors or failures.<br/><br>Possible error codes are:<br>`M0001`: Name must be set.<br>`M0002`: Status must be set.<br>`M0003`: Membership Plan must be set.<br>`M0004`: Monthly Price must be set.<br>`M0005`: Yearly Price must be set.<br>`M0006`: Membership Areas must be set.<br>`M0007`: Membership name already exists.<br>`M0008`: Membership slug already exists.<br>`M0009`: Membership slug must be set.<br>`M0010`: Invalid slug format. Use lowercase and hyphens, e.g., \"this-is-an-example\".<br>`M0011`: Area Liability Waiver agreement is missing for some areas. You must add an agreement for each area prior to activating the membership.<br>`M0012`: One-time pricing options must be set for non-recurring memberships.<br>`M0013`: Pause minimum weeks must be set and greater than 0 when pause is enabled.<br>`M0014`: Pause maximum weeks must be set and greater than 0 when pause is enabled.<br>`M0015`: Pause minimum weeks must be less than or equal to pause maximum weeks.<br>`M0016`: Pause fee must be equal or greater than 0.<br>`M0017`: Pause minimum weeks for monthly must be set and greater than 0 when monthly pause is enabled.<br>`M0018`: Pause maximum weeks for monthly must be set and greater than 0 when monthly pause is enabled.<br>`M0019`: Pause minimum weeks for monthly must be less than or equal to pause maximum weeks for monthly.<br>`M0020`: Pause minimum weeks for yearly must be set and greater than 0 when yearly pause is enabled.<br>`M0021`: Pause maximum weeks for yearly must be set and greater than 0 when yearly pause is enabled.<br>`M0022`: Pause minimum weeks for yearly must be less than or equal to pause maximum weeks for yearly.<br>`M0023`: Presales end date changed. Confirm to adjust next charge dates for existing subscribers."}},"tags":["Memberships"]}}}}
```

## GET /memberships/{membershipId}/subscriptions-count

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/memberships/{membershipId}/subscriptions-count":{"get":{"operationId":"MembershipController_findCount","parameters":[{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `Number`","content":{"application/json":{"schema":{"type":"number"}}}}},"tags":["Memberships"]}}}}
```

## GET /memberships/{membershipId}/has-or-had-members

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/memberships/{membershipId}/has-or-had-members":{"get":{"operationId":"MembershipController_hasOrHadMembers","parameters":[{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `true` if the membership has or had members, `false` otherwise","content":{"application/json":{"schema":{"type":"boolean"}}}}},"tags":["Memberships"]}}}}
```

## GET /memberships/{membershipId}/benefits

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/memberships/{membershipId}/benefits":{"get":{"operationId":"MembershipController_findBenefits","parameters":[{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `MembershipBenefitsCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"}}}}},"tags":["Memberships"]}}}}
```

## GET /memberships/{membershipId}/one-time-price-options

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/memberships/{membershipId}/one-time-price-options":{"get":{"operationId":"MembershipController_findOneTimePriceOptions","parameters":[{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a `OneTimePriceOptionsCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"}}}}},"tags":["Memberships"]}}}}
```

## GET /memberships/{membershipId}/areas

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["GLOBAL_MEMBER","ANGEL_MEMBER","BASIC_MEMBER","AREA_MEMBER"]},"membershipPlan":{"$ref":"#/components/schemas/MembershipPlanDto"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","SOLD_OUT"]},"yearlyPrice":{"type":"number"},"monthlyPrice":{"type":"number"},"monthlyDisplayPrice":{"type":"string"},"initiationFeeMonthly":{"type":"number"},"initiationFeeYearly":{"type":"number"},"additionalMemberFee":{"type":"number"},"additionalMembersCap":{"type":"number"},"bookingHorizonDays":{"type":"number","description":"If specified, overrides the tenant setting `company.bookingHorizonDays.members`"},"benefits":{"$ref":"#/components/schemas/MembershipBenefitsCollectionDto"},"showSubscriptionDetails":{"type":"boolean"},"allowPublicCancellation":{"type":"boolean"},"isGroupMembership":{"type":"boolean"},"areas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"membershipAreas":{"$ref":"#/components/schemas/ItemRefCollectionDto"},"tags":{"type":"string","enum":["MOST_POPULAR","LIMITED_AVAILABILITY"]},"settings":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"},"subscriptionsCount":{"type":"number","readOnly":true,"nullable":true},"hasOrHadMembers":{"type":"boolean","readOnly":true},"slug":{"type":"string"},"taxRegionId":{"type":"string","readOnly":true},"allowedChargeTypes":{"type":"array","items":{"type":"string","enum":["YEARLY","MONTHLY","NON_RECURRING"]}},"contactEmail":{"type":"string"},"oneTimePriceOptions":{"$ref":"#/components/schemas/OneTimePriceOptionsCollectionDto"},"priceChangeScope":{"type":"string","enum":["ALL_CURRENT","NEW_ONLY"],"description":"Scope for price changes: ALL_CURRENT updates existing members, NEW_ONLY applies only to new subscriptions"},"presalesEndDateChangeScope":{"type":"string","enum":["ADJUST_SUBSCRIPTIONS","NO_CHANGE"],"description":"Scope for presales end date changes: ADJUST_SUBSCRIPTIONS updates existing subscribers, NO_CHANGE leaves subscriptions unchanged"},"adjustMonthlyGrantDates":{"type":"boolean","description":"When true and presalesEndDateChangeScope is ADJUST_SUBSCRIPTIONS, also adjusts nextGrantDate for monthly subscriptions"},"errors":{"readOnly":true,"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorDto"}},"_links":{"type":"object"}},"required":["id","displayName","description","type","membershipPlan","status","benefits","areas","membershipAreas","tags","settings","slug","allowedChargeTypes","errors","_links"]},"MembershipPlanDto":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"}},"required":["id","displayName"]},"MembershipBenefitsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipBenefitDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"MembershipBenefitDto":{"type":"object","properties":{}},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]},"ItemRefCollectionDto":{"type":"object","properties":{"items":{"description":"The array containing the elements of the collection","type":"array","items":{"type":"string"}},"_total":{"type":"number","description":"The total amount of elements in this collection, counting also the elements from the succesive pages"},"_links":{"description":"A `LinksDto` structure containing URL references to propertes that can be expanded","allOf":[{"$ref":"#/components/schemas/LinksDto"}]}},"required":["items"]},"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"OneTimePriceOptionsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OneTimePriceOptionDto"}},"_links":{"$ref":"#/components/schemas/LinksDto"},"_total":{"type":"number"}},"required":["items","_links","_total"]},"OneTimePriceOptionDto":{"type":"object","properties":{"id":{"type":"string"},"price":{"type":"number"},"durationDays":{"type":"number"},"listed":{"type":"boolean"}},"required":["id","price","durationDays","listed"]},"ValidationErrorDto":{"type":"object","properties":{"code":{"type":"string","readOnly":true},"message":{"type":"string","readOnly":true},"details":{"type":"object","readOnly":true,"nullable":true}},"required":["code","message","details"]}}},"paths":{"/memberships/{membershipId}/areas":{"get":{"operationId":"MembershipController_findAreas","parameters":[{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an `AreaCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipDto"}}}}},"tags":["Memberships"]}}}}
```

## GET /memberships/{membershipId}/settings

>

```json
{"openapi":"3.0.0","info":{"title":"PodPlay Inc API","version":"2.0"},"tags":[{"name":"Memberships","description":"Membership plans, subscriptions, enrollments, and prepaid packages."}],"servers":[{"url":"/apis/v2","description":"Current Server"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"MembershipSettingsCollectionDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MembershipSettingDto"}},"_total":{"type":"number"},"_links":{"$ref":"#/components/schemas/LinksDto"}},"required":["items","_total","_links"]},"MembershipSettingDto":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"enum":["membership.priority","membership.freeQuickReplaysWelcome","membership.freeQuickReplaysMonthly","membership.virtualCreditsWelcome","membership.virtualCreditsMonthly","membership.coachingDiscountPercentage","membership.ballMachineDiscountPercentage","membership.monthlyPackageTemplateId","membership.listed","membership.subscriptorsCap","membership.extraMemberFee","membership.notificationsEnabled","membership.taxRegionId","membership.stripeTransferAreaId","membership.maxFutureRegularReservations","membership.maxFutureEventSignupsByCustomType","membership.presalesEndDate","membership.minCancellationNoticeDaysMonthly","membership.minCancellationNoticeDaysYearly","membership.minTenancyDays","membership.creditCardFeePercentage","membership.creditCardFeeName","membership.canBePaused","membership.pauseMinWeeks","membership.pauseMaxWeeks","membership.pauseFee","membership.canBePausedMonthly","membership.canBePausedYearly","membership.pauseMinWeeksMonthly","membership.pauseMinWeeksYearly","membership.pauseMaxWeeksMonthly","membership.pauseMaxWeeksYearly","membership.pauseFeeMonthly","membership.pauseFeeYearly","membership.allowPublicCancellation"]},"value":{"type":"object"}},"required":["id","value"]},"LinksDto":{"type":"object","properties":{"self":{"description":"A `LinkDto` to the resource itself","allOf":[{"$ref":"#/components/schemas/LinkDto"}]}},"required":["self"]},"LinkDto":{"type":"object","properties":{"href":{"type":"string","description":"A URL"}},"required":["href"]}}},"paths":{"/memberships/{membershipId}/settings":{"get":{"operationId":"MembershipController_findAreaSettings","parameters":[{"name":"membershipId","required":true,"in":"path","schema":{"type":"string"}},{"name":"areaId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns `MembershipSettingsCollection`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipSettingsCollectionDto"}}}}},"tags":["Memberships"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.podplay.app/api/memberships.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.