---
title: "Get the workspace subscription, processing limit, and storage snapshot"
method: GET
path: "/v1/billing"
---

# Get the workspace subscription, processing limit, and storage snapshot

`GET /v1/billing`

## Request

- Base URL: `https://actiondock.app`
- URL: `https://actiondock.app/v1/billing`
- Auth: HTTP bearer

## Response `200`

Billing snapshot

- BillingSnapshot
  - `workspace` object, required
    - `id` string, uuid, required: Workspace identifier.
    - `name` string, required
    - `email` string, required
    - `status` 'pending' | 'active' | 'suspended', required
    - `plan` 'launch' | 'growth' | 'scale', required
    - `subscriptionStatus` string, required
    - `billingProvider` 'lemonsqueezy' | 'paddle', nullable, required
    - `billingPeriodStart` string, date-time, nullable, required: Current period start.
    - `billingPeriodEnd` string, date-time, nullable, required: Current period end.
    - `subscriptionEndsAt` string, date-time, nullable, required: Scheduled end of the subscription.
    - `createdAt` string, date-time, required: Creation time.
    - `updatedAt` string, date-time, required: Last update.
  - `billingCycle` 'monthly' | 'annual', nullable, required
  - `sandbox` boolean, required: True for a free sandbox workspace: one built-in connection, a one-off allowance, no subscription.
  - `processing` object, required
    - `status` 'available' | 'paused', required
    - `remainingPercent` number, required
    - `usedPercent` number, required
    - `resetsAt` string, date-time, nullable, required: Next processing limit reset.
    - `overageCharges` false, required
  - `plan` object, required
    - `monthlyPriceUsd` number, required
    - `annualPriceUsd` number, required
    - `maxConnections` integer, required
    - `reportStorageBytes` integer, required
  - `storage` object, required
    - `bytes` integer, required
    - `files` integer, required
    - `quotaBytes` integer, required

## Other responses

- `401`: Missing, invalid, or revoked workspace API key.
- `404`: Resource not found or outside the caller's workspace.
- `429`: Rate limit exceeded (rate_limit_exceeded).

---

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