Membership | SumUp Developer

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

Fields

idstringrequired
ID of the membership.

Example: "mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP"
resource_idstringrequired
ID of the resource the membership is in.

Example: "M2DDT39A"
typestringrequired
The type of the membership resource. Possible values are:
- merchant - merchant account(s)
- organization - organization(s)
Example: "merchant"
rolesarray<string>required
User's roles.

Example: ["role_admin"]
permissionsarray<string>requireddeprecated
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_atstringrequired
format: date-time
The timestamp of when the membership was created.

Example: "2023-01-20T15:16:17Z"
updated_atstringrequired
format: date-time
The timestamp of when the membership was last updated.

Example: "2023-01-20T15:16:17Z"
statusstringrequired
Options:"accepted""pending""expired""disabled""unknown"
The status of the membership.
resourceobjectrequired
Information about the resource the membership is in.
Show 7 properties
- idstringrequired
  ID of the resource the membership is in.
  
  Example: "M2DDT39A"
- typestringrequired
  The type of the membership resource. Possible values are:
  
  merchant - merchant account(s)
  
  organization - organization(s)
  
  Example: "merchant"
- namestringrequired
  Display name of the resource.
  
  Example: "Acme Corp"
- created_atstringrequired
  format: date-time
  The timestamp of when the membership resource was created.
  
  Example: "2023-01-20T15:16:17Z"
- updated_atstringrequired
  format: date-time
  The timestamp of when the membership resource was last updated.
  
  Example: "2023-01-20T15:16:17Z"
- logostring
  format: urimaxLength: 256
  Logo fo the resource.
  
  Example: "https://images.sumup.com/img_2x4y6z8a0b1c2d3e4f5g6h7j8k.png"
- attributesobject
  Object attributes that are modifiable only by SumUp applications.
  
  Example: {}
inviteobject
Pending invitation for membership.
Show 2 properties
- emailstringrequired
  format: email
  Email address of the invited user.
  
  Example: "boaty.mcboatface@sumup.com"
- expires_atstringrequired
  format: date-time
  Example: "2023-01-20T15:16:17Z"
metadataobject
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: {}
attributesobject
Object attributes that are modifiable only by SumUp applications.

Example: {}