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

Changelog

API releases and notable changes. A change that would break an integration is announced here at least 30 days before it ships, and ships as a new major version.

v1.3.2 — 2026-11-03

  • customer.storage_alert: detail.tier (hot, cold or deep_freeze) names the storage pool the alert is about, and percentage, usedBytes and limitBytes are that pool's. Only a full hot pool stops backups; a full cold or Deep Freeze pool refuses new data to that tier only. The once-a-week rule now applies per pool and level, so an alert for one pool no longer holds back another pool's.

v1.3.1 — 2026-10-21

  • On installations that let an address sign up again: POST /v1/customers/{id}/extend-trial (an ended free trial runs again for 1 to the trial length days, as often as you like), new codes ENDED_TRIAL_EXISTS (on create: the address belongs to one of your customers whose free trial has ended — extend, upgrade or delete it first), TRIAL_EXTENSION_UNAVAILABLE and TRIAL_NOT_EXTENDABLE, and FORBIDDEN with details.reason TRIAL_CLOSED for a trial closed because its address signed up again. channelTrial gains closed and extendable.

v1.3 — 2026-10-05

The integration release: what a PSA, RMM or billing connector needs, in one go.

  • Ledger, invoices, statements: GET /v1/account/ledger (one signed row shape over every source — wallet, distributor, BigMIND 1.0 — with kind, source, a cursor for exports), GET /v1/invoices[/{id}[/pdf]] (the PDF: Stripe's when hosted there, else rendered), GET /v1/account/statements (resellers: the monthly statement, JSON or CSV).
  • Backup status: GET /v1/customers/{id}/backup-status (summary, devices with health, sessions with errorSummary), GET /v1/backup-status/failing (partner-wide, latest backup failed since …); GET /v1/customers/{id}/devices rows gain agentVersion, lastSeenAt, online, lastBackupAt, lastBackupStatus, lastSuccessfulBackupAt and consecutiveFailures.
  • Events: 13 dedicated events — customer.suspended / reactivated / grace_started / grace_ended / trial_converted / trial_ended / plan_change_scheduled / plan_change_applied / plan_change_dropped / storage_alert, backup.failed / backup.recovered (once per failure streak per device) and partner.price_change_notice — each with the customer object and a detail block. customer.updated keeps firing alongside.
  • Webhooks: GET/POST /v1/webhooks, GET/PATCH/DELETE /v1/webhooks/{id}, …/test, …/rotate-secret (secret shown once; immediate swap), the delivery log GET …/deliveries[/{deliveryId}] (30 days) and POST …/redeliver. Every event now carries id (evt_…) and the X-Webhook-Id header, the same on every retry and redelivery. 10 endpoints per partner. The portal's Settings → Webhooks shows the secret once and gains a Deliveries drawer.
  • Idempotency-Key: a retry with the same key and body gets the stored response (Idempotent-Replayed: true) for 24 hours; a different body is 422 IDEMPOTENCY_KEY_REUSED; a request still running is 409 IDEMPOTENCY_IN_PROGRESS. On the writes listed on the Authentication page.
  • Quotes: POST /v1/quotes (a new customer, through the create's own path: same gates, same figure), POST /v1/quotes/compare (which plan fits) and POST /v1/customers/{id}/plan-change/preview (the PATCH's planChange plus funding, nothing written). The portal's live quote runs the same gates now.
  • Tags: GET/POST /v1/tags, PATCH/DELETE /v1/tags/{id}, GET/PUT /v1/customers/{id}/tags and POST/DELETE …/tags/{tagId}; tags on create. GET /v1/customers takes tag (repeatable), renewingWithin and sortBy / sortDir, and every row carries tags, channelTrial and licence.
  • Customers: GET /v1/customers leaves deleted customers out unless you ask for status=deleted; summary counts follow. GET /v1/customers/{id} still returns a deleted customer.
  • Resellers: GET /v1/account and GET /v1/plans: a reseller priced by its distributor's template gets tier template, the template's name, discountPercent (discountRate) null and priceTemplate { id, name }. It read template:<name> with a 0% discount it does not have.

v1.2 — 2026-10-04

The API caught up with the channel pricing restructure, and a review of every endpoint.

  • General availability: The Beta label is gone. v1 is stable: fields and endpoints are only added within v1; anything that would break an integration ships as v2 and is announced here 30 days ahead.
  • Plans: GET /v1/plans is rebuilt on the same resolver as the portal. It lists every plan you sell — DR-Only, Standard, Professional, Vault, Local DR, Home and your own plans — one entry per product with both billing cycles, the extra-user price, what each plan includes and your margin. It used to list only Standard and Professional, priced Vault and Home as Professional, and answered an empty list for partners who priced after 2026-05-25. GET /v1/plans/{id} accepts the product key, either plan id or your plan id. Breaking: entries are per product (id = standard, not bigmind-standard-yearly); the flat retailPrice / wholesaleCost / profitMargin fields are kept with the monthly figures.
  • Customers: PATCH with billingCycle on a catalog plan now moves the customer to the plan's other-cycle id at the renewal (it used to be a no-op). extraUsers and billingCycle on a free-trial, free or BigMIND 1.0 customer are refused with VALIDATION_FAILED instead of being dropped. Two creates of one address at once answer 409 CUSTOMER_EXISTS (was a 500). The 201 body's customerAccount carries id, email, name and language only.
  • Account & Usage: GET /v1/account returns the wholesale tier your prices come from (tier, tierDisplayName, discountPercent), your gift credit and your distributor. GET /v1/usage/summary reports creditsUsed as what was spent, creditsRefunded separately and netCredits (refunds used to be netted silently).
  • Errors: INSUFFICIENT_CREDITS is 402 everywhere (create was 400). Bad pagination (page < 1, limit outside 1–200) and a body that is not JSON answer 400 VALIDATION_FAILED (were 500). An expired partner account is read-only (403 PARTNER_READ_ONLY) and a channel mid-migration takes no writes (423 MIGRATION_IN_PROGRESS), as in the portal. The errors page lists every code.
  • Second pass (2026-10-05): DELETE /v1/customers/{id}/pending-change cancels a change waiting for the renewal. calculateProrating is ignored (false used to apply a change without charging it). A catalog plan id with a contradicting billingCycle on create moves to the matching cycle id. A plan priced for one customer cannot be sold to another. Revoking or regenerating a key takes effect at once (no 60 s cache). customer.updated now fires for every status change the platform makes (grace, suspension for credit, top-up reactivation, trial converted / ended, scheduled changes), customer.deleted for platform deletions, and credits.low / credits.depleted actually fire. Suspend / reactivate payloads carry the full customer; a suspended trial resumes as a trial. GET /v1/customers rows: seats is the paid users, plan.billingCycle added; GET /v1/customers/{id}: plan.displayName is your name for the plan (catalogName added), creditHistory rows carry usageType and description. Unknown status filters, over-long search strings and a reversed usage window answer 400. Field lengths are checked (191 / 50 characters). send-welcome is limited to active or trial customers, once per 10 minutes. Webhook URLs are checked against private addresses on save and on every delivery; unknown event names are refused. The distributor's cost no longer appears in billingConfig.
  • Retired: The never-documented /v1/subscriptions/activate and /v1/subscriptions/{userId} routes answer 410 ENDPOINT_RETIRED. Use POST /v1/customers and the customer routes.
  • Webhooks: X-Webhook-Attempt now counts from 1 as documented (it counted from 0). A delivery waits 10 s for your answer, then counts as failed and is retried.

v1.1.1 — 2026-09-26 → 2026-10-03

Free trial, plan changes, renewals.

  • Customers: POST /v1/customers takes trial (free 15-day trial; TRIAL_NOT_AVAILABLE, TRIAL_ALREADY_USED, TRIAL_LIMIT_REACHED), billingCycle and extraUsers; free accounts are refused (FREE_ACCOUNTS_DISCONTINUED). PATCH follows the portal's rules — bigger now and prorated, smaller or a new cycle at the renewal, refused when the account would not fit (CAPACITY_EXCEEDED) — and returns the outcome in planChange. DELETE returns emailReleased; re-creating a deleted customer with kept data answers CUSTOMER_DELETED_EMAIL_HELD. A reseller's sale the distributor cannot cover answers DISTRIBUTOR_ACCOUNT_LIMIT. The list summary describes the whole filtered set.
  • Webhooks: subscription.renewed after every renewal and customer.renewal_upcoming 7, 3 and 1 days before; customer.* and subscription.* payloads carry the plan, price, cycle and period.

v1.1 — 2026-09-16

Customer list monitoring fields.

  • Customers: GET /v1/customers rows now include usedStorageGB, lastBackupAt, subscriptionExpiresAt and lastLoginAt, so a monitoring dashboard syncs in one paginated pass; GET /v1/customers/{id} also returns subscriptionExpiresAt. Timestamps in the list, POST /v1/customers and PATCH /v1/customers/{id} responses are ISO 8601 strings and decimal prices are strings (they were previously serialised as {} and as an internal digit array).

v1.0 Beta — 2026-05-13

Initial Beta release.

  • Customers: create, list, get, update (plan / seats / add-ons with prorated credit), suspend, reactivate, delete (with prorated refund), resend welcome email
  • Plans: list enabled plans + retail/wholesale/margin; get plan by ID (superseded in v1.2)
  • Account & Usage: partner profile + credits balance; paginated credit-usage history; per-customer storage/devices; partner-wide rollup with optional date range
  • Webhooks: customer.*, subscription.*, credits.* with HMAC-SHA256 signatures
  • Auth: API keys via Authorization: Bearer sk_live_… (also X-API-Key:). Single active key per partner. SHA-256 hashed at rest.
  • Rate limit: 120 req/min per partner

Roadmap

Planned. Subject to change.

  • Multiple API keys per partner with scoped permissions
  • Test-mode keys (sk_test_…)
  • Official SDKs (Node.js, Python)
  • OpenAPI 3.1 spec download
  • IP allowlisting per key