Skip to main content
GET
/
organization
/
settings
Organization settings
curl --request GET \
  --url https://api.beyondwords.io/v1/organization/settings \
  --header 'X-Api-Key: <api-key>'
{
  "stripe": {
    "customer_id": "<string>",
    "plan_id": "<string>",
    "pending_plan_id": "<string>",
    "subscription_id": "<string>"
  },
  "plan": {
    "id": 123,
    "name": "<string>",
    "interval": "<string>",
    "currency": "<string>",
    "amount": 123,
    "permission": "<string>",
    "custom": true,
    "overage_enabled": true,
    "overage_billing_threshold": 123,
    "overage_price": 123,
    "promotion_codes": [
      {
        "type": "<string>",
        "value": 123
      }
    ]
  },
  "pending_plan": {
    "id": 123,
    "name": "<string>",
    "interval": "<string>",
    "currency": "<string>",
    "amount": 123,
    "permission": "<string>",
    "custom": true,
    "overage_enabled": true,
    "overage_billing_threshold": 123,
    "overage_price": 123,
    "promotion_codes": [
      {
        "type": "<string>",
        "value": 123
      }
    ]
  },
  "subscription": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "quota": {
    "type": "<string>",
    "interval": "<string>",
    "limit": 123,
    "content_overage_enabled": true,
    "content_overage_limit": 123,
    "remaining": 123,
    "used": 123,
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "features": {}
}

Authorizations

X-Api-Key
string
header
required

Response

200 - application/json

OK

stripe
object
plan
object
pending_plan
object
subscription
object
quota
object
features
object