Memberships | SumUp Developer

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.

The Membership object

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

id string required

ID of the membership.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
resource_id string required

ID of the resource the membership is in.

Example: "M2DDT39A"
type string required
The type of the membership resource. Possible values are:
- merchant - merchant account(s)
- organization - organization(s)
Example: "merchant"
roles []string required

User's roles.
permissions []string required deprecated

Permissions include only legacy permissions, please use roles instead. Member access is based on their roles within a given resource and the permissions these roles grant.

User's permissions.
created_at string required format: date-time

The timestamp of when the membership was created.

Example: "2023-01-20T15:16:17Z"
updated_at string required format: date-time

The timestamp of when the membership was last updated.

Example: "2023-01-20T15:16:17Z"
invite Invite

Pending invitation for membership.
Show attributes
Close

Invite
- email string required format: email
  
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_at string required format: date-time
  
  Example: "2023-01-20T15:16:17Z"
status string required

Options: acceptedpendingexpireddisabledunknown

The status of the membership.
metadata object max properties: 64

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 object

Object attributes that are modifiable only by SumUp applications.

Example: {}
resource Resource required

Information about the resource the membership is in.
Show attributes
Close

Resource
- id string required
  
  ID of the resource the membership is in.
  
  Example: "M2DDT39A"
- type string required
  
  The type of the membership resource. Possible values are:
  
  merchant - merchant account(s)
  
  organization - organization(s)
  
  Example: "merchant"
- name string required
  
  Display name of the resource.
  
  Example: "Acme Corp"
- logo string max length: 256, format: uri
  
  Logo fo the resource.
  
  Example: "https://images.sumup.com/img_2x4y6z8a0b1c2d3e4f5g6h7j8k.png"
- created_at string required format: date-time
  
  The timestamp of when the membership resource was created.
  
  Example: "2023-01-20T15:16:17Z"
- updated_at string required format: date-time
  
  The timestamp of when the membership resource was last updated.
  
  Example: "2023-01-20T15:16:17Z"
- attributes object
  
  Object attributes that are modifiable only by SumUp applications.
  
  Example: {}

1
{
2
  "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
3
  "resource_id": "M2DDT39A",
4
  "type": "merchant",
5
  "roles": [
6
    "role_admin"
7
  ],
8
  "permissions": [
9
    "members_read",
10
    "members_write",
11
    "create_moto_payments",
12
    "full_transaction_history_view",
13
    "refund_transactions",
14
    "create_referral",
15
    "developer_settings_edit",
16
    "developer_settings_access"
17
  ],
18
  "created_at": "2023-01-20T15:16:17Z",
19
  "updated_at": "2023-01-20T15:16:17Z",
20
  "invite": {
21
    "email": "boaty.mcboatface@sumup.com",
22
    "expires_at": "2023-01-20T15:16:17Z"
23
  },
24
  "status": "",
25
  "metadata": {},
26
  "attributes": {},
27
  "resource": {
28
    "id": "M2DDT39A",
29
    "type": "merchant",
30
    "name": "Acme Corp",
31
    "logo": "https://images.sumup.com/img_2x4y6z8a0b1c2d3e4f5g6h7j8k.png",
32
    "created_at": "2023-01-20T15:16:17Z",
33
    "updated_at": "2023-01-20T15:16:17Z",
34
    "attributes": {}
35
  }
36
}

Memberships

List memberships

GET /v0.1/memberships

List memberships of the current user.

Query Parameters

offset integer minimum: 0, default: 0

Offset of the first member to return.

Example: 0
limit integer minimum: 1, maximum: 25, default: 10

Maximum number of members to return.

Example: 10
kind string

Filter memberships by resource kind.

Example: "merchant"
status string

Options: acceptedpendingexpireddisabledunknown

Filter the returned memberships by the membership status.
resource.type string

Filter memberships by resource kind.

Example: "merchant"
resource.attributes.sandbox boolean

Filter memberships by the sandbox status of the resource the membership is in.
resource.name string

Filter memberships by the name of the resource the membership is in.
resource.parent.id string nullable

Filter memberships by the parent of the resource the membership is in. When filtering by parent both resource.parent.id and resource.parent.type must be present. Pass explicit null to filter for resources without a parent.
resource.parent.type object nullable

Filter memberships by the parent of the resource the membership is in. When filtering by parent both resource.parent.id and resource.parent.type must be present. Pass explicit null to filter for resources without a parent.
roles []string

Filter the returned memberships by role.

Example: ["role_employee","role_accountant"]

Response

Returns a list of Membership objects. See Membership object .

items []Membership required

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

Membership
- id string required
  
  ID of the membership.
  
  Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
- resource_id string required
  
  ID of the resource the membership is in.
  
  Example: "M2DDT39A"
- type string required
  
  The type of the membership resource. Possible values are:
  
  merchant - merchant account(s)
  
  organization - organization(s)
  
  Example: "merchant"
- roles []string required
  
  User's roles.
- permissions []string required deprecated
  
  Permissions include only legacy permissions, please use roles instead. Member access is based on their roles within a given resource and the permissions these roles grant.
  
  User's permissions.
- created_at string required format: date-time
  
  The timestamp of when the membership was created.
  
  Example: "2023-01-20T15:16:17Z"
- updated_at string required format: date-time
  
  The timestamp of when the membership was last updated.
  
  Example: "2023-01-20T15:16:17Z"
- invite Invite
  
  Pending invitation for membership.
  
  Show attributes
  
  Close
  
  Invite
  
  email string required format: email
  
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
  
  expires_at string required format: date-time
  
  Example: "2023-01-20T15:16:17Z"
- status string required
  
  Options: acceptedpendingexpireddisabledunknown
  
  The status of the membership.
- metadata object max properties: 64
  
  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 object
  
  Object attributes that are modifiable only by SumUp applications.
  
  Example: {}
- resource Resource required
  
  Information about the resource the membership is in.
  
  Show attributes
  
  Close
  
  Resource
  
  id string required
  
  ID of the resource the membership is in.
  
  Example: "M2DDT39A"
  
  type string required
  
  The type of the membership resource. Possible values are:
  
  merchant - merchant account(s)
  
  organization - organization(s)
  
  Example: "merchant"
  
  name string required
  
  Display name of the resource.
  
  Example: "Acme Corp"
  
  logo string max length: 256, format: uri
  
  Logo fo the resource.
  
  Example: "https://images.sumup.com/img_2x4y6z8a0b1c2d3e4f5g6h7j8k.png"
  
  created_at string required format: date-time
  
  The timestamp of when the membership resource was created.
  
  Example: "2023-01-20T15:16:17Z"
  
  updated_at string required format: date-time
  
  The timestamp of when the membership resource was last updated.
  
  Example: "2023-01-20T15:16:17Z"
  
  attributes object
  
  Object attributes that are modifiable only by SumUp applications.
  
  Example: {}
total_count integer required

Example: 3

1
curl https://api.sumup.com/v0.1/memberships \
2
 -X GET \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.memberships.list();

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Memberships.ListAsync();

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.memberships().listMemberships();

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.memberships.list()

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->memberships->list();

1
client := sumup.NewClient()
2

3
result, err := client.Memberships.List(context.Background())

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.memberships().list(sumup::ListMembershipsParams{
6
    offset: Some(0),
7
    limit: Some(10),
8
    kind: Some("merchant".to_string()),
9
    status: Some("status".to_string()),
10
    resource_type: Some("merchant".to_string()),
11
    resource_attributes_sandbox: Some("resource.attributes.sandbox".to_string()),
12
    resource_name: Some("resource.name".to_string()),
13
    resource_parent_id: Some("resource.parent.id".to_string()),
14
    resource_parent_type: Some("resource.parent.type".to_string()),
15
    roles: Some(["role_employee","role_accountant"]),
16
}).await;

1
{
2
  "items": [
3
    {
4
      "id": "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP",
5
      "resource_id": "M2DDT39A",
6
      "type": "merchant",
7
      "roles": [
8
        "role_admin"
9
      ],
10
      "permissions": [
11
        "members_read",
12
        "members_write",
13
        "create_moto_payments",
14
        "full_transaction_history_view",
15
        "refund_transactions",
16
        "create_referral",
17
        "developer_settings_edit",
18
        "developer_settings_access"
19
      ],
20
      "created_at": "2023-01-20T15:16:17Z",
21
      "updated_at": "2023-01-20T15:16:17Z",
22
      "invite": {
23
        "email": "boaty.mcboatface@sumup.com",
24
        "expires_at": "2023-01-20T15:16:17Z"
25
      },
26
      "status": "",
27
      "metadata": {},
28
      "attributes": {},
29
      "resource": {
30
        "id": "M2DDT39A",
31
        "type": "merchant",
32
        "name": "Acme Corp",
33
        "logo": "https://images.sumup.com/img_2x4y6z8a0b1c2d3e4f5g6h7j8k.png",
34
        "created_at": "2023-01-20T15:16:17Z",
35
        "updated_at": "2023-01-20T15:16:17Z",
36
        "attributes": {}
37
      }
38
    }
39
  ],
40
  "total_count": 3
41
}