---
title: "Get workspace subscription status"
method: GET
path: "/workspaces/{workspace_id}/subscription/status"
tags: ["Stripe Subscriptions"]
---

# Get workspace subscription status

`GET /workspaces/{workspace_id}/subscription/status`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}/subscription/status`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

## Response `200`

Request fulfilled, document follows

- WorkspaceSubscriptionStatusDataSchema
  - `workspace_id` integer, required
  - `subscription_status` string, nullable
  - `has_active_subscription` boolean, required
  - `stripe_subscription_id` string, nullable
  - `stripe_customer_id` string, nullable
  - `plan_id` integer, nullable
  - `billing_cycle` string, nullable
  - `checkout_info` object, nullable
  - `needs_checkout` boolean, required
  - `checkout_in_progress` boolean, required
  - `next_action` string
  - `next_action_message` string, nullable
  - `next_action_url` string, nullable
  - `trial_days_remaining` integer
  - `is_trial_expired` boolean
  - `payment_action_required` boolean
  - `days_until_workspace_deletion` integer, nullable
  - `scheduled_change_at` integer, nullable
  - `storage_gb` integer, nullable
  - `storage_allowance_gb` integer

## Other responses

- `400`: Bad request syntax or unsupported method

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/5dfd1c296ded?raw)