---
title: "Get workspace subscription details"
method: GET
path: "/api/v2/workspace-billing/subscription-details"
tags: ["WorkspaceBilling"]
---

# Get workspace subscription details

`GET /api/v2/workspace-billing/subscription-details`

Requires one of the following scopes: `workspace_billing:read`, `workspace_billing:all`, `all:read`, `all:all`

## Response `200`

Default Response

- object
  - `subscriptions` object[]
    - `workspace_id` string, uuid — The ID of the workspace
    - `interval` 'month' | 'year' — The billing interval of the subscription
    - `quantity` number — The quantity of subscribed items
    - `product_id` 'pid_ls_v1' | 'pid_hg_v1' | 'pid_g_v1' | 'pid_g_v2' | 'pid_nic_v1' | 'pid_nic_v1_annual' | 'pid_gic_v1' | 'pid_gic_v1_annual' | 'pid_sic_v1' | 'pid_sic_v1_annual' | 'pid_hic_v1' | 'pid_hic_v1_annual' | 'pid_verify_v1_monthly' | 'pid_hv_v1' | 'pid_hv_v1_annual' | 'pid_lsv_v1' | 'pid_lsv_v1_annual' | 'pid_crm_hg' | 'pid_crm_g' | 'pid_ip_g' | 'pid_ip_hg' | 'pid_addon_25kl_v1' | 'pid_addon_lf_10k_v1' | 'pid_addon_ic_50k_v1' | 'pid_addon_lf_10k_v1_annual' | 'pid_addon_ic_50k_v1_annual' | 'pid_bundle_starter_v1' | 'pid_bundle_scale_v1' | 'pid_bundle_agency_v1' — The Id of outreach plan subscribed to
    - `product_type` 'prt_outreach' | 'prt_leadfinder' — The type of product subscribed to
    - `plan_type` 'plt_addon' | 'plt_primary' — The type of plan - either primary plan or addon
    - `current_period_end` number — Unix timestamp when the current billing period ends
    - `cancel_at_time` number, nullable — Unix timestamp when the subscription will be canceled, null if not scheduled for cancellation
    - `price_in_dollars` number — The price of the subscription in dollars
    - `price_id` string — The Stripe price ID associated with this subscription
  - `all_subs_cancelled` boolean — Indicates whether all subscriptions are either already canceled or scheduled to be canceled at the end of their current billing cycles

## Other responses

- `401` — This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked)
- `402` — This request cannot be fulfilled because the workspace does not have an active paid plan
- `404` — The requested resource was not found
- `429` — You have exceeded the rate limit. Please check the rate limit docs for more information.

---

[API](https://skmtc.net/instantly/apis/api-explorer.md) · [All operations](https://skmtc.net/instantly/apis/api-explorer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instantly/api-explorer/revisions/378d1e253fe7/schema)