Quotes
Price a sale before making it. A quote is the sale's own code path stopped before the first write, so it applies every rule the sale applies — ownership, product grants, enabled and priced plans, the trial rules, your distributor's price list — and a quote that succeeds is a sale that will succeed, bar balance changes.
The figure you are quoted is the figure you are charged
POST /v1/quotes answers quote.wholesale and charge.now; the POST /v1/customers that follows with the same plan, users and cycle charges exactly charge.now to your credit (billingConfig.wholesaleCost on the customer). The preview's planChange.chargeNow is the PATCH's planChange.chargeNow. Prices can change between the two calls only if your price list or your distributor's does.
/v1/quotesPrice a new customer. Same body as the create minus the account details: planId, billingCycle, seats, extraUsers, trial. email is optional — with it, the address checks run too (duplicate, another partner's customer, trial already used).
curl -X POST https://eu-bigmind2.genie9.com/api/partner/v1/quotes \
-H "Authorization: Bearer sk_live_..." -H "Content-Type: application/json" \
-d '{ "planId": "bigmind-standard-monthly", "seats": 3 }'Response fields
| Field | Type | Description |
|---|---|---|
plan | object | id, name (what the customer sees), billingCycle, isCustom, isBm1. |
quote | object | retail (the customer's price per period), wholesale (yours), earn, margin (% of retail), users, includedUsers, extraUsers and lines[] (item, qty, unit, scope) — the same object GET /v1/plans prices from. |
charge | object | now: what the create charges your credit at once (the first period's wholesale; 0 on a trial). breakdown: basePlanCost, addOnCost, aiLensMedicalCost, total. |
funding | object | fundedBy (self, or distributor for a reseller on open credit), balance and balanceAfter (your wallet at quote time — indicative, the sale re-checks), affordable, and reason when it is not (partner_insufficient_balance, distributor_credit_limit_exceeded …). A quote never answers 402: it tells you. |
trial | object | null | On trial: true — days, endsAt, allowance (the whole-account storage during the trial), chargeNow 0 and chargeAtConversion: the plan's first period at today's price. Conversion re-prices on the day. |
provisions | object | null | What the account is provisioned with: storageQuotaGB, coldStorageQuotaGB, deepFreezeQuotaGB, serverSeats, database and workspace counts. null for a BigMIND 1.0 plan. |
Refusals are the create's: INVALID_PLAN, PLAN_NOT_ENABLED, TRIAL_NOT_AVAILABLE, TRIAL_ALREADY_USED (with email), TRIAL_LIMIT_REACHED, CUSTOMER_EXISTS and the other address codes (with email), TRIAL_EXPIRED, CANNOT_SELL. Insufficient credit is not a refusal here — see funding.
/v1/quotes/compareWhich plan fits? Every plan you sell (Home excluded), priced for a stated need: users, storageGB, needsDr, servers, billingCycle. Plans that fit come first, cheapest for the customer first; among them the one that earns you most is flagged mostForYou.
curl -X POST https://eu-bigmind2.genie9.com/api/partner/v1/quotes/compare \
-H "Authorization: Bearer sk_live_..." -H "Content-Type: application/json" \
-d '{ "users": 8, "storageGB": 6000, "needsDr": true, "servers": 1, "billingCycle": "yearly" }'Each option
key and planId (what to send as planId), name, family, model, fits, reasons[] (no_dr, storage, servers, users), storageGB (what the plan gives this many users) and quote as above. A plan that cannot take this many users (Local DR Basic) is left out.
/v1/customers/{id}/plan-change/previewWhat PATCH /v1/customers/{id} would do with these plan fields — planId, seats, extraUsers, billingCycle — without doing it. The response is the PATCH's planChange object (timing, reason, chargeNow, daysRemaining, effectiveAt, current, next, capacity) plus funding. Nothing is written or charged; a change that would not fit comes back with capacity.ok false and its problems, not a 400.
curl -X POST https://eu-bigmind2.genie9.com/api/partner/v1/customers/pc_42_.../plan-change/preview \
-H "Authorization: Bearer sk_live_..." -H "Content-Type: application/json" \
-d '{ "planId": "bigmind-professional-monthly", "seats": 5 }'The same refusals as PATCH for the plan itself (INVALID_PLAN, PLAN_NOT_ENABLED — including a catalog plan you have not priced). A trial, free or BigMIND 1.0 customer, or a BigMIND 1.0 target plan, has no preview: 400 VALIDATION_FAILED with details.code TRIAL_CUSTOMER, FREE_CUSTOMER, BM1_CUSTOMER or BM1_PLAN. CAPACITY_EXCEEDED and INSUFFICIENT_CREDITS are reported in the body, not thrown.