> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.navipartner.com/apis/api-reference/memberships/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.navipartner.com/_mcp/server.

# Introduction to Memberships

At a high level, the membership, member, and card entities form the core building blocks of a flexible system designed to manage the relationships between individuals and the memberships they hold. Each entity has a specific role within the system, and they are interrelated in a way that accommodates a wide range of use cases, such as family memberships, guardianship, and individual access management.

## Membership

A membership represents a defined relationship between an individual or a group of individuals (members) and an organization or service. Each membership can have one or more members, and it includes important information such as the type of membership, its associated benefits, and most importantly, a validity period that defines when the membership is active. A membership may also include complex structures like family memberships where multiple individuals (e.g., parents and children) are grouped together under the same membership umbrella.

The validity of a membership is tied to time periods, which dictate when the membership is active. Time periods can be manipulated through actions like renewals (adding time after the current period), upgrades (changing the benefits while maintaining the same time frame), and extensions (terminating the current period early and starting a new one from today). These actions ensure that memberships are flexible and can adapt to different needs and life situations.

## Member

A member is an individual associated with one or more memberships. In many cases, a member will have a single membership, but they can hold multiple memberships concurrently, especially in scenarios like family memberships or guardianship relationships. For example, a parent may hold their own individual membership but also be a guardian on their child's membership, where they can manage and oversee the child's membership.

The member entity is primarily focused on the person—their personal details, contact information, and their association with one or more memberships. The ability to link members to multiple memberships allows for flexibility in managing groups or families where a person may need to oversee or participate in different memberships simultaneously.

## Card

A card is a physical or virtual representation of a member’s access to their membership. Each member can have zero or more cards, and the cards are tied to specific memberships. Cards are primarily used to authenticate the member's access to services associated with the membership, such as gaining entry to a facility, participating in an event or getting membership benefits such as discounts.

A card is linked to a specific member and a specific membership, providing a bridge between the person and their ability to interact with the membership benefits. Cards can be added, replaced, or removed as needed, and in cases where a card is lost or damaged, it can be replaced with a new one while blocking the old one. Not all members may have cards (for example, in cases where physical access is not required), but the option to assign cards provides flexibility in how memberships are managed.

## Payment Method

A payment method is information about a means of payment (debit/credit card) that can be used by the system to renew the membership. The system doesn't store the actual credit card numbers, only the tokens provided by a supported Payment Service Provider (PSP). The token is then used with the PSP to request the renewal payment. Therefore, if you want to register a new payment method, you'll first need to tokenize the payment card details with a supported PSP.

## Time Periods and Membership Lifecycle Actions

A membership must have a valid time period that defines when it is active. This period ensures that members are only able to use their membership benefits during specific times. Various actions can manipulate these time periods:

* **Renewals:** A renewal adds additional time after the current period, ensuring the membership continues without interruption once the current period ends.

* **Upgrades:** An upgrade does not alter the time period but modifies the membership’s benefits by transitioning it to a higher or lower tier. The current period is terminated, but the overall duration remains the same.

* **Extensions:** An extension creates a new period starting from today, terminating the current period early and ensuring the new period is longer than the original. This action increases the overall membership duration.

These time period adjustments allow memberships to evolve over time, adapting to the changing needs of the member or the organization, while maintaining clarity over when a membership is valid and usable.

> Documentation for NaviPartner's NP Retail, NP Attractions, NP Hospitality, NP Store Assistant and Entria products, plus their REST APIs, built on Microsoft Dynamics 365 Business Central.

## Docs

- [Membership Catalog Services](https://docs.navipartner.com/apis/api-reference/memberships/service-catalog.md)
- [Memberships Services](https://docs.navipartner.com/apis/api-reference/memberships/service-membership.md)
- [Attributes](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/service-membership-attributes.md)
- [Membership Member Services](https://docs.navipartner.com/apis/api-reference/memberships/service-member.md)
- [Memberships Card Services](https://docs.navipartner.com/apis/api-reference/memberships/service-card.md)
- [Payment Method Services](https://docs.navipartner.com/apis/api-reference/memberships/service-paymentmethod.md)
- [Membership Lifecycle Services](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle.md)
- [Miscellaneous](https://docs.navipartner.com/apis/api-reference/memberships/service-misc.md)
- [Introduction to Points](https://docs.navipartner.com/apis/api-reference/memberships/service-points.md)

## API Docs

- Catalog [Get Catalog](https://docs.navipartner.com/apis/api-reference/memberships/service-catalog/get-catalog.md)
- Membership [Create Membership](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/create-membership.md)
- Membership [Get using Id](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/get-membership-id.md)
- Membership [Get using Number](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/get-membership-number.md)
- Membership [Block Membership](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/block-membership.md)
- Membership [Unblock Membership](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/unblock-membership.md)
- Membership [Get Members](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/get-members.md)
- Attributes [List Attributes](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/service-membership-attributes/list-membership-attributes.md)
- Attributes [Get Values](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/service-membership-attributes/get-membership-attribute-values.md)
- Attributes [Set Values](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/service-membership-attributes/set-membership-attribute-values.md)
- Attributes [Remove Values](https://docs.navipartner.com/apis/api-reference/memberships/service-membership/service-membership-attributes/delete-membership-attribute-values.md)
- Member [Get using Id](https://docs.navipartner.com/apis/api-reference/memberships/service-member/get-member-id.md)
- Member [Add Member](https://docs.navipartner.com/apis/api-reference/memberships/service-member/add-member.md)
- Member [Update Member](https://docs.navipartner.com/apis/api-reference/memberships/service-member/update-member.md)
- Member [Get Member Image](https://docs.navipartner.com/apis/api-reference/memberships/service-member/get-member-image.md)
- Member [Set Member Image](https://docs.navipartner.com/apis/api-reference/memberships/service-member/set-member-image.md)
- Member [Find Members](https://docs.navipartner.com/apis/api-reference/memberships/service-member/find-members.md)
- Member [Block Member](https://docs.navipartner.com/apis/api-reference/memberships/service-member/block-member.md)
- Member [Unblock Member](https://docs.navipartner.com/apis/api-reference/memberships/service-member/unblock-member.md)
- Member [Get Member Notes](https://docs.navipartner.com/apis/api-reference/memberships/service-member/get-member-notes.md)
- Member [Add Member Note](https://docs.navipartner.com/apis/api-reference/memberships/service-member/add-member-note.md)
- Attributes [List Attributes](https://docs.navipartner.com/apis/api-reference/memberships/service-member/service-member-attributes/list-member-attributes.md)
- Attributes [Get Values](https://docs.navipartner.com/apis/api-reference/memberships/service-member/service-member-attributes/get-member-attribute-values.md)
- Attributes [Set Values](https://docs.navipartner.com/apis/api-reference/memberships/service-member/service-member-attributes/set-member-attribute-values.md)
- Attributes [Remove Values](https://docs.navipartner.com/apis/api-reference/memberships/service-member/service-member-attributes/delete-member-attribute-values.md)
- Card [Get using Id](https://docs.navipartner.com/apis/api-reference/memberships/service-card/get-card-id.md)
- Card [Get using Number](https://docs.navipartner.com/apis/api-reference/memberships/service-card/get-card-number.md)
- Card [Add Card](https://docs.navipartner.com/apis/api-reference/memberships/service-card/add-card.md)
- Card [Replace Card](https://docs.navipartner.com/apis/api-reference/memberships/service-card/replace-card.md)
- Card [Update Card](https://docs.navipartner.com/apis/api-reference/memberships/service-card/patch-card.md)
- Card [Block Card](https://docs.navipartner.com/apis/api-reference/memberships/service-card/block-card.md)
- Card [Unblock Card](https://docs.navipartner.com/apis/api-reference/memberships/service-card/unblock-card.md)
- Card [Send to Wallet](https://docs.navipartner.com/apis/api-reference/memberships/service-card/send-to-wallet.md)
- Payment Method [Retrieve membership payment methods](https://docs.navipartner.com/apis/api-reference/memberships/service-paymentmethod/get-payment-methods.md)
- Payment Method [Get payment method using Id](https://docs.navipartner.com/apis/api-reference/memberships/service-paymentmethod/get-payment-method.md)
- Payment Method [Add payment method](https://docs.navipartner.com/apis/api-reference/memberships/service-paymentmethod/add-payment-method.md)
- Payment Method [Update payment method](https://docs.navipartner.com/apis/api-reference/memberships/service-paymentmethod/update-payment-method.md)
- Payment Method [Delete payment method](https://docs.navipartner.com/apis/api-reference/memberships/service-paymentmethod/delete-payment-method.md)
- Subscription [Get Subscription](https://docs.navipartner.com/apis/api-reference/memberships/service-subscription/get-subscription.md)
- Subscription [Start Subscription](https://docs.navipartner.com/apis/api-reference/memberships/service-subscription/start-subscription.md)
- Subscription [Terminate Subscription](https://docs.navipartner.com/apis/api-reference/memberships/service-subscription/terminate-subscription.md)
- Lifecycle [Get Membership History](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/get-membership-history.md)
- Lifecycle [Activate Membership](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/activate-membership.md)
- Lifecycle [Get Cancel Options](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/get-cancel-options.md)
- Lifecycle [Cancel Membership](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/cancel-membership.md)
- Lifecycle [Get Renewal Options](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/get-renewal-options.md)
- Lifecycle [Renew Membership](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/renew-membership.md)
- Lifecycle [Get Upgrade Options](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/get-upgrade-options.md)
- Lifecycle [Upgrade Membership](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/upgrade-membership.md)
- Lifecycle [Get Extend Options](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/get-extend-options.md)
- Lifecycle [Extend Membership](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/extend-membership.md)
- Lifecycle [Get Membership Recurring Subscription Payment Information](https://docs.navipartner.com/apis/api-reference/memberships/service-lifecycle/get-membership-recurring-payment-info.md)
- Miscellaneous [Resolve Member Identifier](https://docs.navipartner.com/apis/api-reference/memberships/service-misc/resolve-identifier.md)
- Miscellaneous [List Memberships](https://docs.navipartner.com/apis/api-reference/memberships/service-misc/list-memberships.md)
- Miscellaneous [Get Loyalty Tags](https://docs.navipartner.com/apis/api-reference/memberships/service-misc/get-loyalty-tags.md)
- Miscellaneous [Create Loyalty Tags](https://docs.navipartner.com/apis/api-reference/memberships/service-misc/create-loyalty-tags.md)
- Points [Get Points Balance](https://docs.navipartner.com/apis/api-reference/memberships/service-points/get-points-balance.md)
- Points [Authorize Points Transaction](https://docs.navipartner.com/apis/api-reference/memberships/service-points/authorize-points.md)
- Points [Cancel Point authorization](https://docs.navipartner.com/apis/api-reference/memberships/service-points/cancel-authorization-points.md)
- Points [Register Sale](https://docs.navipartner.com/apis/api-reference/memberships/service-points/register-sale.md)
- Points [Get Points Sale History](https://docs.navipartner.com/apis/api-reference/memberships/service-points/get-receipt-list.md)
- Points [Get Points Transactions](https://docs.navipartner.com/apis/api-reference/memberships/service-points/get-points-transactions.md)
- Webhooks [Membership Created](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-created.md)
- Webhooks [Member Added](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-member-added.md)
- Webhooks [Membership Renew Staged](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-period-renew-staged.md)
- Webhooks [Membership Upgrade Staged](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-period-upgrade-staged.md)
- Webhooks [Membership Extend Staged](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-period-extend-staged.md)
- Webhooks [Membership Auto Renew Staged](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-period-auto-renew-staged.md)
- Webhooks [Membership Period Cancel](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-period-cancel.md)
- Webhooks [Membership Period Regret](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-period-regret.md)
- Webhooks [Membership Period Activated](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-period-activated.md)
- Webhooks [Member Details Updated](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/member-details-updated.md)
- Webhooks [Membership Details Updated](https://docs.navipartner.com/apis/api-reference/memberships/webhooks/membership-details-updated.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.navipartner.com/openapi.json)
- [OpenAPI YAML](https://docs.navipartner.com/openapi.yaml)