Docs

API reference

Billing and data export

An organization's Cactive One subscription, a person's own plan, checkouts on the payment page, tax invoices, the payment provider's webhooks and full exports of an organization's data.

Organizations. /v1/orgs/:orgId/billing is the organization's subscription.

  • Owners and administrators manage it: tenant:read to see it, tenant:write to change it.
  • Business plans are billed per active member, and the first subscription starts with the plan's free trial.
  • When an organization's access has ended, its other routes answer 402. That happens if it never subscribed, cancelled, or payment failed for good.
  • Billing, exports, Tenant, members and the audit log keep working, so it can resubscribe or take its data. Routes of apps its plan doesn't include answer 403.

People. /v1/me/billing is your own plan: storage for Drive and Photos. It's free unless you subscribe. Pro and Max start with a 14-day free trial, once per person.

Billing periods. Every paid plan can be billed monthly (month), yearly (year, ten months' price) or every 2 years (two-year, fifteen months' price). POST …/plan switches plan or period on a live subscription. A new period is charged at once, less the unused part of the current one; during a trial nothing is charged.

Checkouts. Anything that takes a card goes through the payment page, payments.cactive.com.au: starting a plan, replacing the card, or paying an overdue invoice.

  1. POST …/checkout with kind (subscribe, card or invoice) and what it's for: planId and interval, or invoiceId. Add a returnUrl on the calling app's own host. It returns the checkout's url.
  2. Send the person there. The page shows the order, priced from plan data (never from the address), and takes the card. Cards never reach these routes.
  3. The person comes back to returnUrl with ?checkout=<id>&status=complete or status=canceled.

Only the person who started a checkout can open it, and it stays open for an hour. On stages without a payment provider, no card is asked for and nothing is charged.

Money and tax. Amounts are cents in Australian dollars, GST included. Invoices carry the GST and the supplier's ABN.

Exports. POST /v1/orgs/:orgId/exports makes a ZIP (or several) of everything the organization keeps, any time, including after its subscription ends. Only owners, signed in themselves, can export: an export holds every member's My Drive and every mailbox.