Skip to main content
POST
/
organisations
/
subscription
/
{
  "email": "jsmith@example.com",
  "name": "<string>",
  "image_url": "<string>",
  "id": "<string>",
  "members": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "jsmith@example.com"
      },
      "permission_level": "VIEWER"
    }
  ],
  "subscription_tier": "BASIC",
  "max_member_limit": 123,
  "seats_renewal_enabled": true,
  "seats_renewal_cycle": "MONTHLY",
  "seats_expired_at": "2023-11-07T05:31:56Z",
  "credit_checks_enabled": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Api-key
string | null

Body

application/json
seat_count
integer
required
Required range: x > 0
renewal_cycle
enum<string>
required
Available options:
MONTHLY,
YEARLY
subscription_tier
enum<string>
Available options:
BASIC,
TEAM

Response

Successful Response

email
string<email>
required
name
string
required
image_url
string | null
required
id
string
required
members
MemberRead · object[]
required
subscription_tier
enum<string> | null
required
Available options:
BASIC,
TEAM
max_member_limit
integer | null
required
seats_renewal_enabled
boolean
required
seats_renewal_cycle
enum<string> | null
required
Available options:
MONTHLY,
YEARLY
seats_expired_at
string<date-time> | null
required
credit_checks_enabled
boolean
required