Add a new membership

post

https://app.officernd.com/api/v2/organizations/{orgSlug}/memberships

Required scopes: flex.community.memberships.create

Path Params

orgSlug

string

required

organization slug

Body Params

properties

object

An object that contains all custom properties that can be applied to the item.

name

string

required

The name of the membership.

startDate

string

required

The start date of the membership.

location

string

required

The location of the membership.

plan

string

required

The _id of the plan associated with the membership.

endDate

string

The end date of the membership.

member

string

The _id of the member associated with the membership.

company

string

The _id of the company associated with the membership.

isPersonal

boolean

If enabled, the membership will be charged to the member.

type

string

enum

The type of the membership.

Allowed:

intervalLength

string

enum

The membership interval. It could be "once", "hour", "day", or "month".

Allowed:

price

number

The price of the membership.

deposit

number

The deposit amount for the membership.

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201