---
title: "Membership"
description: "A membership associates a user with a resource, memberships is defined by user, resource, resource type, and associated roles."
image: "https://developer.sumup.com/og/index.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.sumup.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: SumUp REST API

A membership associates a user with a resource, memberships is defined by user, resource, resource type, and associated roles.

## Fields

- `id` (`Membership.id`; string, required) — ID of the membership.
  - example `"mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"`
- `resource_id` (`Membership.resource_id`; string, required) — ID of the resource the membership is in.
  - example `"M2DDT39A"`
- `type` (`Membership.type`; string, required) — The type of the membership resource. Possible values are: * `merchant` - merchant account(s) * `organization` - organization(s)
  - example `"merchant"`
- `roles` (`Membership.roles`; array<string>, required) — User's roles.
  - example `["role_admin"]`
- `permissions` (`Membership.permissions`; array<string>, required, deprecated) — User's permissions.
  - example `["members_read","members_write","create_moto_payments","full_transaction_history_view","refund_transactions","create_referral","developer_settings_edit","developer_settings_access"]`
- `created_at` (`Membership.created_at`; string, required) — The timestamp of when the membership was created.
  - format `date-time`; example `"2023-01-20T15:16:17Z"`
- `updated_at` (`Membership.updated_at`; string, required) — The timestamp of when the membership was last updated.
  - format `date-time`; example `"2023-01-20T15:16:17Z"`
- `status` (`Membership.status`; string, required) — The status of the membership.
  - one of `"accepted"`, `"pending"`, `"expired"`, `"disabled"`, `"unknown"`
- `resource` (`Membership.resource`; object, required) — Information about the resource the membership is in.
  - `id` (`Membership.resource.id`; string, required) — ID of the resource the membership is in.
    - example `"M2DDT39A"`
  - `type` (`Membership.resource.type`; string, required) — The type of the membership resource. Possible values are: * `merchant` - merchant account(s) * `organization` - organization(s)
    - example `"merchant"`
  - `name` (`Membership.resource.name`; string, required) — Display name of the resource.
    - example `"Acme Corp"`
  - `created_at` (`Membership.resource.created_at`; string, required) — The timestamp of when the membership resource was created.
    - format `date-time`; example `"2023-01-20T15:16:17Z"`
  - `updated_at` (`Membership.resource.updated_at`; string, required) — The timestamp of when the membership resource was last updated.
    - format `date-time`; example `"2023-01-20T15:16:17Z"`
  - `logo` (`Membership.resource.logo`; string, optional) — Logo fo the resource.
    - format `uri`; maxLength 256; example `"https://images.sumup.com/img_2x4y6z8a0b1c2d3e4f5g6h7j8k.png"`
  - `attributes` (`Membership.resource.attributes`; object, optional) — Object attributes that are modifiable only by SumUp applications.
    - example `{}`
- `invite` (`Membership.invite`; object, optional) — Pending invitation for membership.
  - `email` (`Membership.invite.email`; string, required) — Email address of the invited user.
    - format `email`; example `"boaty.mcboatface@sumup.com"`
  - `expires_at` (`Membership.invite.expires_at`; string, required)
    - format `date-time`; example `"2023-01-20T15:16:17Z"`
- `metadata` (`Membership.metadata`; object, optional) — Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.
  - example `{}`
- `attributes` (`Membership.attributes`; object, optional) — Object attributes that are modifiable only by SumUp applications.
  - example `{}`


Source: https://developer.sumup.com/api/schemas/Membership/index.md