BigMindBigMindBigMind
Partner API
Sign inGet an API key
Partner API
OverviewAuthenticationCustomersPlansQuotesAccount & UsageBackup statusWebhooksError codesChangelog

Plans

Read-only. Every plan you can sell today — the catalog plans you have priced (Resilience, Vault, Local DR, Home) and the plans you built yourself — with your price, what you pay and your margin, per billing cycle. The same list the New customer page offers; use it to fill a plan selector in your CRM or signup flow.

GET/v1/plans

List the plans you sell, one entry per product with both billing cycles inside it.

curl -H "Authorization: Bearer sk_live_..." https://eu-bigmind2.genie9.com/api/partner/v1/plans

Fields

FieldTypeDescription
idstringStable id: the catalog product key (standard, professional, dronly, vault10 … vault100, localBasic, localPlus, localPro, home200, home600, home2tb) or the id of your own plan.
planIdsobjectThe planId to send to POST /v1/customers, per cycle. A catalog product has one id per cycle; your own plan is one id sold on either cycle, so also send billingCycle. null when the product is not sold on that cycle (Local DR is yearly only).
pricingobjectPer cycle: your price (retailPrice), what you pay (wholesaleCost), and the difference (projectedProfit, profitMargin as % of your price). Per user on a per_user plan; per account on a package. null for a cycle the product is not sold on.
source"catalog" | "custom"catalog: a BigMind plan you priced. custom: a plan you built. A plan priced for one customer only ("adjusted" plan) is not listed here; it shows on that customer's own record (GET /v1/customers/{id} → plan, isCustom true) and cannot be sold to anyone else.
family, modelstringfamily: resilience, vault, local, home, package or perUserPlan. model: per_user (priced per user, seats on create) or package (priced per account, extraUsers on create).
includedUsers, extraUsernumber | null, object | nullPackages, Vault and Local DR Plus/Pro include a number of users; each user above that is sold at extraUser.retailPrice and costs you extraUser.wholesaleCost (per cycle). null on per-user plans.
accountFee, accountWholesaleCostobject | nullYour own per-user plans only: the fixed account fee the customer pays on top of the users, and what BigMind charges you for the shared extras in it.
includesobjectWhat the plan provides: hot storage per user (per-user plans) or pooled hot / cold / Deep Freeze GB (packages), devices per user, servers, databases, eDiscovery, DR.
retailPrice, wholesaleCost, projectedProfit, profitMarginnumberKept for v1.0 integrations: the monthly figures (the yearly ones when the product is yearly only).
tier, partnerTier, discountRate, priceTemplateobject, string, number | null, object | nullThe wholesale basis your prices come from: a tier (explorer … enterprise) with its discount off list, or — for a reseller priced by its distributor — tier.name template, the template's name, discountPercent and discountRate null, and priceTemplate { id, name }.

An empty list comes with a message and an action: configure_pricing (set your prices on Pricing › Plans) or contact_distributor (your distributor sets your prices and has not yet).

GET/v1/plans/{id}

One plan, by its product key, by either of its plan ids, or by the id of one of your own plans.

curl -H "Authorization: Bearer sk_live_..." https://eu-bigmind2.genie9.com/api/partner/v1/plans/standard
curl -H "Authorization: Bearer sk_live_..." https://eu-bigmind2.genie9.com/api/partner/v1/plans/bigmind-standard-yearly

Returns INVALID_PLAN (404) if the id is not a plan you sell — another partner's plan answers the same.