---
title: "Read the workspace period and shared execution credits"
method: GET
path: "/v1/billing/status"
tags: ["billing"]
---

# Read the workspace period and shared execution credits

`GET /v1/billing/status`

## Request

- Base URL: `https://api.typenode.ai`
- URL: `https://api.typenode.ai/v1/billing/status`
- Auth: HTTP bearer

## Response `200`

The workspace billing status.

- WorkspaceBillingStatus
  - `can_edit` boolean, required
  - `can_manage_billing` boolean, required
  - `can_run` boolean, required
  - `cancel_at_period_end` boolean, required
  - `catalog` object, required
    - `pack` object, required
      - `price_cents` integer, required
      - `runs` integer, required
    - `pro` object, required
      - `price_cents` integer, required
      - `runs` integer, required
    - `trial` object, required
      - `days` integer, required
      - `paid_price_cents` integer, required
      - `runs` integer, required
  - `complimentary_remaining` number, required
  - `has_redeemed_offer_code` boolean, required
  - `has_stripe_customer` boolean, required
  - `included_allowance` number, required
  - `included_remaining` number, required
  - `payment_retry_ends_at` string, date-time, nullable, required
  - `period_end` string, date-time, nullable, required
  - `period_start` string, date-time, nullable, required
  - `purchased_remaining` number, required
  - `purchased_total` number, required
  - `recent_offers` object[], required
    - `awarded_at` string, date-time, required
    - `extra_days` integer, required
    - `extra_runs` integer, required
    - `operation_id` string, uuid, required
    - `public_name` string, required
    - `trial_activated` boolean, required
    - `trial_after` string, date-time, nullable, required
    - `trial_before` string, date-time, nullable, required
  - `state` 'trial_pending' | 'trial_active' | 'trial_expired' | 'pro_active' | 'pro_expired', required
  - `subscription_status` 'active' | 'past_due' | 'canceled', nullable, required
  - `tenant_id` string, uuid, required
  - `total_spendable` number, required
  - `trial_activated_at` string, date-time, nullable, required
  - `trial_expires_at` string, date-time, nullable, required
  - `trial_offer` 'free' | 'paid', nullable, required
  - `trial_payment_received` boolean, required
  - `workspace_name` string, required

## Other responses

- `401`: Authentication required.
- `403`: Workspace access is required.
- `default`: An error occurred (RFC 9457 problem+json).

---

[API](https://skmtc.dev/typenode/apis/typenode-management-api.md) · [All operations](https://skmtc.dev/typenode/apis/typenode-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/typenode/apis/typenode-management-api/revisions/9b943024aa98?raw)