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

# Get workspace plan details

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

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

## Response `200`

Default Response

- object
  - `organization_id` string, uuid — The id of workspace
  - `organization_name` string — The name of workspace
  - `subscriptions` object
    - `outreach` object
      - `plan_name` string — Plan name
      - `addons_qty` number — Addons total quantity
      - `total_lead_limit` number — Total Outreach plan limit including addons
      - `current_lead_count` number — Current number of leads counted toward the plan
      - `base_lead_limit` number — Base Outreach plan limit without add-ons
      - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable — The billing interval of the outreach subscription
      - `current_period_end` number, nullable — Unix timestamp when the current outreach billing period ends
      - `cancel_at_time` number, nullable — Unix timestamp when the outreach subscription will be canceled, null if not scheduled for cancellation
      - `price_in_dollars` number, nullable — The outreach subscription price in dollars
      - `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' | 'null', nullable — The ID of the outreach plan subscribed to
    - `credits` object
      - `plan_name` string — Instantly Credits plan name
      - `total_credits` number — Total Instantly Credits included in the current plan
      - `available_credits` number — Available Instantly Credits balance for the workspace
      - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable — The billing interval of the Instantly Credits subscription
      - `current_period_end` number, nullable — Unix timestamp when the current Instantly Credits billing period ends
      - `cancel_at_time` number, nullable — Unix timestamp when the Instantly Credits subscription will be canceled, null if not scheduled for cancellation
      - `price_in_dollars` number, nullable — The Instantly Credits subscription price in dollars
      - `product_id` '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' | 'null', nullable — The ID of the Instantly Credits plan subscribed to
      - `price_option_id` string, nullable — The selected Instantly Credits price option ID
    - `bundle` object
      - `plan_name` string, nullable
      - `total_lead_limit` number — Total bundled Outreach contact limit
      - `current_lead_count` number — Current number of contacts counted toward the bundled Outreach limit
      - `base_lead_limit` number — Base bundled Outreach contact limit
      - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable
      - `current_period_end` number, nullable
      - `cancel_at_time` number, nullable
      - `price_in_dollars` number, nullable
      - `product_id` 'pid_bundle_starter_v1' | 'pid_bundle_scale_v1' | 'pid_bundle_agency_v1' | 'null', nullable
    - `crm` object
      - `plan_name` string, nullable
      - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable
      - `current_period_end` number, nullable
      - `cancel_at_time` number, nullable
      - `price_in_dollars` number, nullable
      - `product_id` string, nullable
      - `available_credits` number, nullable
      - `plan_limit` number, nullable
    - `website_visitors` object
      - `plan_name` string, nullable
      - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable
      - `current_period_end` number, nullable
      - `cancel_at_time` number, nullable
      - `price_in_dollars` number, nullable
      - `product_id` string, nullable
      - `available_credits` number, nullable
      - `plan_limit` number, nullable
    - `inbox_placement` object
      - `plan_name` string, nullable
      - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable
      - `current_period_end` number, nullable
      - `cancel_at_time` number, nullable
      - `price_in_dollars` number, nullable
      - `product_id` string, nullable
      - `available_credits` number, nullable
      - `plan_limit` number, nullable
  - `addons` object
    - `outreach` object
      - `product_id` 'pid_addon_25kl_v1' — The product ID for the Outreach add-on.
      - `unit_lead_limit` number — Number of additional contacts included in one add-on unit.
      - `existing_quantity` number — Current quantity of Outreach add-on units.
      - `max_quantity` number — Maximum additional units selectable in one update.
      - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable — The current billing interval for the Outreach add-on subscription.
      - `can_purchase` boolean — Whether the workspace can purchase Outreach add-ons.
      - `purchase_blocked_reason` string, nullable — Reason add-on purchase is blocked, null when purchase is allowed.
      - `annual_discount_percent` number — Annual billing discount percentage.
      - `monthly_pricing_tiers` object[]
        - `from_quantity` number
        - `to_quantity` number, nullable
        - `price_in_dollars` number
    - `credits` object
      - `product_id` 'pid_addon_ic_50k_v1' — The monthly product ID for the Instantly Credits add-on.
      - `annual_product_id` 'pid_addon_ic_50k_v1_annual' — The annual product ID for the Instantly Credits add-on.
      - `unit_credits` number — Number of additional monthly credits included in one add-on unit.
      - `annual_unit_credits` number — Number of additional annual credits included in one add-on unit.
      - `existing_quantity` number — Current quantity of Instantly Credits add-on units.
      - `max_quantity` number — Maximum additional units selectable in one update.
      - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable — The current billing interval for the Instantly Credits add-on subscription.
      - `can_purchase` boolean — Whether the workspace can purchase Instantly Credits add-ons.
      - `purchase_blocked_reason` string, nullable — Reason add-on purchase is blocked, null when purchase is allowed.
      - `monthly_price_in_dollars` number — Monthly price for one Instantly Credits add-on unit in dollars.
      - `annual_price_in_dollars` number — Annual price for one Instantly Credits add-on unit in dollars.

## 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)