Sign in
Super Admin Subscriptions

Create a new subscription for a specific organization

Changed on

Create a new subscription for the specified organization. This endpoint is only accessible to super admins.

post/super-admin/subscriptions/{orgId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

orgIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

Organization ID to create subscription for

Request body

companyNamestring required

Company name for the subscription

streetstring required

Street for the subscription

houseNumberstring required

House number for the subscription

postalCodestring required

Postal code for the subscription

citystring required

City for the subscription

countrystring required

Country for the subscription

vatNumberstring

VAT number for the subscription

type'SEAT_BASED' | 'USAGE_BASED'

Subscription type. Defaults to SEAT_BASED if not specified.

noOfSeatsnumber

Number of seats for the subscription (seat-based only)

monthlyCreditsnumber

Monthly credit budget (usage-based only)

subTextstring

Sub text for the subscription

startsAtstring

Start date for the subscription (ISO 8601). If omitted, the subscription starts immediately.

Example request

{
  "companyName": "Acme Inc.",
  "street": "123 Main St",
  "houseNumber": "123",
  "postalCode": "12345",
  "city": "New York",
  "country": "United States",
  "vatNumber": "1234567890",
  "type": "SEAT_BASED",
  "noOfSeats": 10,
  "monthlyCredits": 1000,
  "subText": "Sub text",
  "startsAt": "2026-07-01T00:00:00.000Z"
}

Response

Successfully created subscription

idstring uuid required

Unique identifier of the subscription

createdAtstring date-time required

Date when the subscription was created

updatedAtstring date-time required

Date when the subscription was last updated

cancelledAtobject

Date when the subscription was cancelled (if applicable)

startsAtstring date-time required

Date when the subscription becomes active

accessEndsAtstring date-time nullable required

Exclusive date when this subscription stops controlling product access

orgIdstring uuid required

Organization ID associated with the subscription

type'SEAT_BASED' | 'USAGE_BASED' required

Subscription type

noOfSeatsnumber

Number of seats in the subscription (seat-based only)

pricePerSeatnumber

Price per seat in the subscription (seat-based only)

renewalCycle'monthly' | 'yearly'

Renewal cycle of the subscription (seat-based only)

renewalCycleAnchorstring date-time

Date that serves as the anchor for renewal cycles (seat-based only)

monthlyCreditsnumber

Monthly credit budget (usage-based only)

availableSeatsnumber nullable

Number of available seats (total seats minus invites, seat-based only)

nextRenewalDatestring date-time required

Date of the next renewal

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2023-12-01T10:00:00Z",
  "updatedAt": "2023-12-01T10:00:00Z",
  "startsAt": "2026-07-01T00:00:00Z",
  "accessEndsAt": "2026-08-01T00:00:00Z",
  "orgId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "SEAT_BASED",
  "noOfSeats": 10,
  "pricePerSeat": 29.99,
  "renewalCycle": "monthly",
  "renewalCycleAnchor": "2023-12-01T10:00:00Z",
  "monthlyCredits": 1000,
  "availableSeats": 3,
  "nextRenewalDate": "2024-01-01T10:00:00Z",
  "billingInfo": {
    "companyName": "Acme GmbH",
    "street": "Musterstraße",
    "houseNumber": "123a",
    "city": "Musterstadt",
    "postalCode": "12345",
    "country": "Deutschland",
    "vatNumber": "DE1234567890"
  }
}

Changes