---
title: "Organization settings"
method: GET
path: "/organization/settings"
tags: ["Organization"]
---

# Organization settings

`GET /organization/settings`

## Request

- Base URL: `https://api.beyondwords.io/v1`
- URL: `https://api.beyondwords.io/v1/organization/settings`
- Auth: API key in header `X-Api-Key`

Users should be able to get their organization settings

## Response `200`

OK

- OrganizationSettingsModel
  - `stripe` object
    - `customer_id` string: stripe id of the customer
    - `plan_id` string, nullable: stripe id of the plan
    - `pending_plan_id` string, nullable: stripe id of the pending plan
    - `subscription_id` string, nullable: stripe id of the subscription
  - `plan` PlanModel
    - `id` integer
    - `name` string
    - `interval` string
    - `currency` string
    - `amount` integer
    - `permission` string
    - `custom` boolean
    - `overage_enabled` boolean
    - `overage_billing_threshold` integer, nullable
    - `overage_price` integer, nullable
    - `promotion_codes` object[], nullable
      - `type` string
      - `value` integer
  - `pending_plan` PlanModel
    - `id` integer
    - `name` string
    - `interval` string
    - `currency` string
    - `amount` integer
    - `permission` string
    - `custom` boolean
    - `overage_enabled` boolean
    - `overage_billing_threshold` integer, nullable
    - `overage_price` integer, nullable
    - `promotion_codes` object[], nullable
      - `type` string
      - `value` integer
  - `subscription` object
    - `start` string, date-time
    - `end` string, date-time, nullable
  - `quota` object
    - `type` string
    - `interval` string
    - `limit` integer
    - `content_overage_enabled` boolean
    - `content_overage_limit` integer, nullable
    - `remaining` integer
    - `used` integer
    - `start` string, date-time
    - `end` string, date-time, nullable
  - `features` object

## Changes

- **2026-11-03** `994b9853e685`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/beyondwords/apis/beyondwords-rest-api/changes/organization/settings/get.md)

---

[API](https://skmtc.dev/beyondwords/apis/beyondwords-rest-api.md) - [All operations](https://skmtc.dev/beyondwords/apis/beyondwords-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondwords/apis/beyondwords-rest-api/revisions/994b9853e685?raw)