Get Memberships

Description

This endpoint allows you to retrieve the available memberships/plans, with filtering options by name, branch, update date, among others. It is also possible to include additional information such as activity groups, online sales observations, access branches, add-on memberships, and more.

NOTE. Available for use with both Branch Access Keys and General Admin Access Keys.

🔑 Query Parameters

Parameter	Type	Required	Description
`idMembership`	int	No	Filters by a specific membership ID.
`name`	string	No	Filters by membership name.
`idBranch`	int	No	Filters by branch ID. Ignored if the API key is not multi-location.
`take`	int	No	Total number of records to return (maximum: 200). Default: 25.
`skip`	int	No	Number of records to skip (for pagination). Default: 0.
`active`	boolean	No	Filters by active or inactive memberships.
`showAccessBranches`	boolean	No	Displays the branches where the membership grants access. Default: `false`.
`showOnlineSalesObservation`	boolean	No	Displays observations related to online sales. Default: `false`.
`updateDate`	string (ISO)	No	Filters memberships updated from this date onward (`yyyy-mm-dd`).
`showActivitiesGroups`	boolean	No	Displays the activity groups linked to the membership. Default: `false`.
`externalSaleAvailable`	boolean	No	Allows external sales. Default: `false`.
`showSuspensionRules`	boolean	No	Displays suspension rules in the response. Default: `false`.
`showCancellationRules`	boolean	No	Displays cancellation rules in the response. Default: `false`.
`showContract`	boolean	No	Displays the contract structure in the response. Default: `false`.
`showTurnstiles`	boolean	No	Displays the turnstiles linked to the membership, either directly or through a turnstile group, in the response. Default: `false`.
`showAdditionalMemberships`	boolean	No	When `true`, returns the linked add-on memberships and the `additionalValueProportionalToDuration` configuration of the main membership. Default: `false`.

📤 Response Structure

The response returns the complete data of a plan, including commercial information, billing rules, additional services, activity groups, associated branches, entries, sales pages, and eligibility settings.

Field	Type	Description
`idMembership`	int32	Unique identifier of the plan.
`idBranch`	int32	ID of the branch associated with the plan.
`nameMembership`	string	Name of the plan.
`membershipType`	string	Type of plan. See below.
`durationType`	string	Type of plan duration (e.g., Days or Months).
`duration`	int32	Plan duration according to the defined type.
`updateDate`	date-time	Date of the last plan update.
`value`	number (double)	Plan value. Includes the sum of the add-ons linked to the plan, both fixed and optional.
`maxAmountInstallments`	int32	Maximum number of installments allowed.
`description`	string	Detailed plan description.
`urlSale`	string (read-only)	Public URL for selling the plan.
`onlineSalesObservations`	string	Observations displayed in the online sales flow.
`diferentials`	arrayobject	List of differentials associated with the plan. See below.
`accessBranches`	arrayobject	List of branches where the plan is valid. See below.
`additionalService`	arrayobject	Additional service linked to the plan. See below.
`serviceYearly`	arrayobject	Annual service associated with the plan. See below.
`typePromotionalPeriod`	int32	Type of promotional period applied to the plan or service, defining the promotion duration rule.
`valuePromotionalPeriod`	number	Value applied during the promotional period. Includes the sum of the add-ons linked to the plan, both fixed and optional.
`monthsPromotionalPeriod`	int32	Number of months in the promotional period, when applicable.
`daysPromotionalPeriod`	int32	Number of days in the promotional period, when applicable.
`minPeriodStayMembership`	int32	Minimum period of stay in the plan.
`installmentsPromotionalPeriod`	int32	Number of installments allowed during the promotional period.
`activitiesGroups`	arrayobject	Activity groups linked to the plan. See below.
`inactive`	boolean	Indicates whether the plan is inactive.
`displayName`	string	Formatted display name of the plan.
`entries`	arrayobject	Configuration of entries allowed by the plan. See below.
`salesPage`	arrayobject	Sales pages associated with the plan. See below.
`allowsCancellationByApp`	boolean	Indicates whether the plan can be canceled through the app.
`externalSaleAvailable`	boolean	Indicates whether the plan can be sold externally.
`acceptEnrollment`	boolean	Indicates whether direct enrollment is accepted.
`enrollmentRequired`	boolean	Indicates whether enrollment is required.
`contractSuspension`	arrayobject	Suspension rules linked to the plan. See below.
`contractCancellation`	arrayobject	Cancellation rules linked to the plan. See below.
`htmlContract`	string	Structure of the contract linked to the plan.
`turnstiles`	array	List of turnstiles associated with the plan/membership.
`additionalValueProportionalToDuration`	boolean	Indicates whether the value of add-on memberships should be proportional to the duration of the main membership.
`additionalMemberships`	arrayobject	Add-on memberships linked to the main membership. See below.

🧩 `membershipType` Values

The membershipType field represents the membership modality configured under Administrative > Memberships.

Common contract

Monthly contract with automatic renewal

Plan extension

Locking extension

Monthly recurring debit

Recurring debit with term

Additional dependents

Annual contract with a defined end date

Add-on membership

Scheduled recurring Pix with term

Automatic monthly Pix

NOTE. The membershipType field does not indicate whether an add-on membership has a fixed or optional link. For add-on memberships, this information is represented by the additionalType field within additionalMemberships.

🧩 `diferentials` Structure

Field	Type	Description
`title`	string	Differential title.
`order`	int32	Priority order.

🧩 `accessBranches` Structure

Field	Type	Description
`idBranch`	int32	Identifier of the branch the member has access to.
`name`	string	Name of the branch the member has access to.

🧩 `additionalService` Structure

Field	Type	Description
`idService`	int32	Identifier of the additional service.
`name`	string	Name of the additional service.
`value`	number	Value of the additional service.

🧩 `serviceYearly` Structure

Field	Type	Description
`idService`	int32	ID of the annual service.
`name`	string	Name of the annual service.
`value`	number (double)	Value of the annual service.
`type`	int32	Service billing type.
`billingMonth`	int32	Billing month.
`billingDay`	int32	Billing day.
`billingAfterMonths`	int32	Number of months after enrollment before billing.
`installments`	int32	Number of installments.
`typePromotionalPeriod`	int32	Type of promotional period.
`valuePromotionalPeriod`	number (double)	Promotional value.
`monthsPromotionalPeriod`	int32	Number of promotional months.
`daysPromotionalPeriod`	int32	Number of promotional days.
`installmentsPromotionalPeriod`	int32	Installments during the promotional period.

🧩 `activitiesGroups` Structure

Field	Type	Description
`idGroupActivity`	int32	Activity group ID.
`name`	string	Activity group name.
`idBranch`	int32	ID of the branch associated with the group.

🧩 `entries` Structure

Field	Type	Description
`entriesQuantity`	int32	Number of allowed entries.
`idEntriesType`	int32	Configured entry type.
`entriesTypeDescription`	string	Description of the entry type.

🧩 `salesPage` Structure

Field	Type	Description
`idSalesPage`	int32	Sales page ID.
`order`	int32	Display order of the plan on the page.
`salesPageDescription`	string	Sales page description.

🧩 `contractSuspension` Structure

Field	Type	Description
`maxSuspensionsAllowed`	int32	Maximum number of suspensions allowed for the contract.
`totalSuspensionDays`	int32	Total number of suspension days allowed for the contract.
`minimumPeriodBeforeSuspensionDays`	int32	Minimum period, in days, before contract suspension is allowed.
`firstSuspensionGracePeriodMonths`	int32	Grace period, in months, for the first contract suspension.
`nextSuspensionsGracePeriodMonths`	int32	Grace period, in months, for subsequent contract suspensions.

🧩 `contractCancellation` Structure

Field	Type	Description
`considerClosedCompetencyOnCancellation`	boolean	Indicates whether the closed competency should be considered upon cancellation.
`priorNoticeDays`	int32	Number of prior notice days required for cancellation.
`applyPenaltyAutomatically`	boolean	Indicates whether the penalty should be automatically applied upon cancellation.
`penaltyOverRemainingContractValue`	boolean	Indicates whether the penalty should be calculated over the remaining contract value.
`minimumGracePeriodMonths`	int32	Minimum grace period, in months, for applying the cancellation rules.
`penaltyPercentage`	number	Penalty percentage applied upon contract cancellation.

🧩 `additionalMemberships` Structure

Field	Type	Description
`idMembership`	int32	Identifier of the add-on membership.
`nameMembership`	string	Name of the add-on membership.
`membershipType`	string	Modality of the add-on membership.
`value`	number (double)	Value configured in the add-on membership.
`inactive`	boolean	Indicates whether the add-on membership is inactive.
`additionalType`	string	Type of link between the main membership and the add-on. Possible values are `Fixed` or `Optional`.
`defaultSaleValue`	number (double)	Default value that will be used by the Sales and Carts flows when `membershipValue` is not provided for the add-on. It may vary according to the `additionalValueProportionalToDuration` flag.

🚧 Add-on Membership Rules
Fixed: identifies a mandatory add-on that is automatically included when the main membership is sold and cannot be sold separately.
Optional: identifies an add-on that can be selected by the integration, sold together with the main membership, or sold separately when the member already has an eligible main membership.
The link type belongs to the combination of main membership + add-on membership. Therefore, the same add-on membership may be Fixed for one main membership and Optional for another.
When additionalValueProportionalToDuration is false, defaultSaleValue corresponds to the value configured for the add-on membership.
When additionalValueProportionalToDuration is true, defaultSaleValue corresponds to the configured add-on value multiplied by the number of months in the main membership duration. For main memberships with a 1-month duration, the value is not changed.
When the integration provides membershipValue during the sale, the provided value is considered the final value of the add-on and is not multiplied by the duration again.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

application/json

Success

Body

Example

[
    {
        "idMembership": 0,
        "idBranch": 0,
        "nameMembership": "string",
        "membershipType": "string",
        "durationType": "string",
        "duration": 0,
        "updateDate": "2019-08-24T14:15:22.123Z",
        "value": 0,
        "maxAmountInstallments": 0,
        "description": "string",
        "urlSale": "string",
        "onlineSalesObservations": "string",
        "differentials": [
            {
                "title": "string",
                "order": 0
            }
        ],
        "accessBranches": [
            {
                "idBranch": 0,
                "name": "string"
            }
        ],
        "additionalService": {
            "idService": 0,
            "name": "string",
            "value": 0
        },
        "serviceYearly": {
            "idService": 0,
            "name": "string",
            "value": 0,
            "type": 0,
            "billingMonth": 0,
            "billingDay": 0,
            "billingAfterMonths": 0,
            "installments": 0
        },
        "typePromotionalPeriod": 0,
        "valuePromotionalPeriod": 0,
        "monthsPromotionalPeriod": 0,
        "daysPromotionalPeriod": 0,
        "minPeriodStayMembership": 0,
        "installmentsPromotionalPeriod": 0,
        "activitiesGroups": [
            {
                "idGroupActivity": 0,
                "name": "string",
                "idBranch": 0
            }
        ],
        "inactive": true,
        "displayName": "string",
        "entries": {
            "entriesQuantity": 0,
            "idEntriesType": 0,
            "entriesTypeDescription": "string"
        },
        "salesPage": [
            {
                "idSalesPage": 0,
                "order": 0,
                "salesPageDescription": "string"
            }
        ],
        "allowsCancellationByApp": true,
        "externalSaleAvailable": true,
        "acceptEnrollment": true,
        "enrollmentRequired": true,
        "contractSuspension": {
            "maxSuspensionsAllowed": 0,
            "totalSuspensionDays": 0,
            "minimumPeriodBeforeSuspensionDays": 0,
            "firstSuspensionGracePeriodMonths": 0,
            "nextSuspensionsGracePeriodMonths": 0
        },
        "contractCancellation": {
            "considerClosedCompetencyOnCancellation": true,
            "priorNoticeDays": 0,
            "applyPenaltyAutomatically": true,
            "penaltyOverRemainingContractValue": true,
            "minimumGracePeriodMonths": 0,
            "penaltyPercentage": 0
        },
        "htmlContract": "string",
        "turnstiles": [
            0
        ],
        "additionalValueProportionalToDuration": true,
        "additionalMemberships": [
            {
                "idMembership": 0,
                "nameMembership": "string",
                "membershipType": "string",
                "value": 0,
                "inactive": true,
                "additionalType": "string",
                "defaultSaleValue": 0
            }
        ]
    }
]

Get memberships

Get Memberships

Description

🔑 Query Parameters

📤 Response Structure

🧩 `membershipType` Values

🧩 `diferentials` Structure

🧩 `accessBranches` Structure

🧩 `additionalService` Structure

🧩 `serviceYearly` Structure

🧩 `activitiesGroups` Structure

🧩 `entries` Structure

🧩 `salesPage` Structure

🧩 `contractSuspension` Structure

🧩 `contractCancellation` Structure

🧩 `additionalMemberships` Structure

Request

Request Code Samples

Responses

Get memberships

Get Memberships#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 membershipType Values#

🧩 diferentials Structure#

🧩 accessBranches Structure#

🧩 additionalService Structure#

🧩 serviceYearly Structure#

🧩 activitiesGroups Structure#

🧩 entries Structure#

🧩 salesPage Structure#

🧩 contractSuspension Structure#

🧩 contractCancellation Structure#

🧩 additionalMemberships Structure#

Request

Request Code Samples

Responses

Get Memberships

Description

🔑 Query Parameters

📤 Response Structure

🧩 `membershipType` Values

🧩 `diferentials` Structure

🧩 `accessBranches` Structure

🧩 `additionalService` Structure

🧩 `serviceYearly` Structure

🧩 `activitiesGroups` Structure

🧩 `entries` Structure

🧩 `salesPage` Structure

🧩 `contractSuspension` Structure

🧩 `contractCancellation` Structure

🧩 `additionalMemberships` Structure