INinstantly
WorkspaceBilling

Get workspace plan details

Changed on

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

get/api/v2/workspace-billing/plan-details

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/workspace-billing/plan-details
  • Auth
    HTTP bearer

Response

Default Response

organization_idstring uuid

The id of workspace

organization_namestring

The name of workspace

Example response

{
  "organization_id": "01a19e6f-8eaf-77a3-969c-e0ad48c3f7b3",
  "organization_name": "My Default Workspace",
  "subscriptions": {
    "outreach": {
      "plan_name": "Free Trial",
      "addons_qty": 2,
      "total_lead_limit": 100,
      "current_lead_count": 10,
      "base_lead_limit": 25000,
      "interval": "month",
      "current_period_end": 1704067200,
      "cancel_at_time": 1704067200,
      "price_in_dollars": 97,
      "product_id": "pid_g_v1"
    },
    "credits": {
      "plan_name": "Free Trial",
      "total_credits": 100,
      "available_credits": 75,
      "interval": "month",
      "current_period_end": 1704067200,
      "cancel_at_time": 1704067200,
      "price_in_dollars": 97,
      "product_id": "pid_gic_v1",
      "price_option_id": "growth_2000"
    },
    "bundle": {
      "plan_name": "Scale Bundle",
      "total_lead_limit": 25000,
      "current_lead_count": 10,
      "base_lead_limit": 25000,
      "interval": "month",
      "current_period_end": 1704067200,
      "cancel_at_time": 1704067200,
      "price_in_dollars": 265,
      "product_id": "pid_bundle_scale_v2"
    },
    "crm": {
      "plan_name": "Growth CRM",
      "interval": "month",
      "current_period_end": 1704067200,
      "cancel_at_time": 1704067200,
      "price_in_dollars": 47,
      "product_id": "pid_crm_g"
    },
    "website_visitors": {
      "plan_name": "Hyper Visitors",
      "interval": "month",
      "current_period_end": 1704067200,
      "cancel_at_time": 1704067200,
      "price_in_dollars": 97,
      "product_id": "pid_hv_v1",
      "available_credits": 280,
      "plan_limit": 500
    },
    "inbox_placement": {
      "plan_name": "Growth Inbox Placement",
      "interval": "month",
      "current_period_end": 1704067200,
      "cancel_at_time": 1704067200,
      "price_in_dollars": 47,
      "product_id": "pid_ip_g"
    }
  },
  "addons": {
    "outreach": {
      "product_id": "pid_addon_25kl_v1",
      "unit_lead_limit": 25000,
      "existing_quantity": 2,
      "max_quantity": 20,
      "interval": "month",
      "can_purchase": true,
      "purchase_blocked_reason": "advanced_outreach_plan_required",
      "annual_discount_percent": 20,
      "monthly_pricing_tiers": [
        {
          "from_quantity": 1,
          "to_quantity": 5,
          "price_in_dollars": 87
        }
      ]
    },
    "credits": {
      "product_id": "pid_addon_ic_50k_v1",
      "annual_product_id": "pid_addon_ic_50k_v1_annual",
      "unit_credits": 50000,
      "annual_unit_credits": 600000,
      "existing_quantity": 2,
      "max_quantity": 10,
      "interval": "month",
      "can_purchase": true,
      "purchase_blocked_reason": "hyper_credits_plan_required",
      "monthly_price_in_dollars": 425,
      "annual_price_in_dollars": 5100
    }
  }
}

Changes

  • c781051105a8Revision changes
    • warning

      added the new pid_bundle_agency_v2 enum value to the // response property for the response status

    • warning

      added the new pid_bundle_agency_v2 enum value to the // response property for the response status

    • warning

      added the new pid_bundle_scale_v2 enum value to the // response property for the response status

    • warning

      added the new pid_bundle_scale_v2 enum value to the // response property for the response status

    • warning

      added the new pid_hg_v2 enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status