Class Memberships

API resource for the Memberships endpoints.

Endpoints to manage user's memberships. Memberships are used to connect the user to merchant accounts and to grant them access to the merchant's resources via roles.

Hierarchy

APIResource
- Memberships

Index

Constructors

Properties

Methods

Constructors

constructor

new Memberships(client: SumUp): Memberships
Parameters
- client: SumUp
Returns Memberships
Inherited from APIResource.constructor
- Defined in src/core.ts:8

Properties

`Protected`_client

_client: SumUp

Methods

list

list(
query?: ListMembershipsQueryParams,
options?: RequestOptions,
): APIPromise<ListMembershipsResponse, Problem>
List memberships of the current user.
Parameters
- Optionalquery: ListMembershipsQueryParams
- Optionaloptions: RequestOptions
Returns APIPromise<ListMembershipsResponse, Problem>
- Defined in src/resources/memberships/index.ts:37