Every HTTP operation with its path, credential, scope, SDK methods and purpose, plus Funnel commands and public endpoints.
84 ordinary operations: 78 available and 6 reserved operations that return HTTP 501. There are also 25 Funnel commands and 6 public configuration and experiment endpoints. Every operation runs under its credential, scope and App/environment checks.
createIndianaServer, Customer Token operations on the browser createIndiana.Find or create a Customer by externalUserId or email; an existing profile is never overwritten.
/api/v1/customersRead a Customer by Customer UUID or externalUserId.
/api/v1/customers/getFilter and paginate Customers by search, tag, Product, status and creation time.
/api/v1/customers/listPartially update profile, attributes and tags under a retained requestId; replays return the original result.
/api/v1/customers/updateIssue a Customer Token for a browser or app after your backend authenticates the user.
/api/v1/customer-sessionsRotate a still-valid Customer Token for the same Customer.
/api/v1/customer-sessions/renewRevoke one Session or all Sessions of a Customer.
/api/v1/customer-sessions/revokeCreate or resume a Guest from a guestToken generated and retained by your backend.
/api/v1/customers/guestsIssue a Customer Token for a verified Guest.
/api/v1/customers/guests/sessionBind a Guest to an externalUserId after login; an existing Customer switches identity without merging history.
/api/v1/customers/guests/claimCheck whether a Feature requirement is met; observes access without consuming usage.
/api/v1/entitlements/checkResolve a published Offering Version, its candidate Products and availability.
/api/v1/offerings/resolveResolve a standalone Paywall, its pinned Offering Version and presentation.
/api/v1/paywalls/resolveRead a Customer or Entity's memberships, purchases and balances.
/api/v1/customer-holdingsRead one balance source with its revision and state.
/api/v1/balances/source/readAdd, subtract, set or edit a balance source guarded by its expected available amount.
/api/v1/balances/source/adjustRead usage of a Feature, optionally for an Entity, in its current period.
/api/v1/usage/readSet usage with management permission; ordinary consumption uses trackUsage.
/api/v1/usage/setCreate, update, adjust or revoke balance grants, including expiry, reset and rollover.
/api/v1/balances/grants/managePage through a Customer's balance grants.
/api/v1/balances/grants/listUpsert or archive an Entity owned by the Customer, such as a workspace or device.
/api/v1/usage/entitiesRead scoped usage aggregates.
/api/v1/usage/analyticsRead credit analytics derived from balance and financial records.
/api/v1/credits/analyticsAccept a batch of usage under a requestId (HTTP 202); each item keeps its consumption identity.
/api/v1/usage/batchPage through the per-item results of a usage batch.
/api/v1/usage/batch/readRead a page of the Customer ledger with its business references.
/api/v1/customer-ledgerRead a consistent credit statement for a time range and snapshot.
/api/v1/credit-statements/readQuote a consumption without consuming, reserving or charging.
/api/v1/balances/quoteReport usage by event name or Feature and receive per-item receipts.
/api/v1/usage/trackQuote, consume, reserve, confirm, refund or release balance.
/api/v1/balances/executeStart collecting a payment method; it neither charges nor invoices.
/api/v1/billing/setup-paymentRead the result of a payment-method setup.
/api/v1/billing/payment-setupVerify a Customer's subscription facts and ownership without charging.
/api/v1/subscriptions/verifyCreate a fixed quote and operationId for the chosen Products, Provider and currency; no charge.
/api/v1/subscriptions/preview-attachConfirm or cancel a quoted purchase; the transaction and signed callbacks decide the result.
/api/v1/subscriptions/attachRead a purchase operation; use it to recover an unknown outcome.
/api/v1/subscriptions/operations/readQuote an upgrade, downgrade or cancellation effective immediately, at renewal or through the store.
/api/v1/subscriptions/preview-updateConfirm or cancel a quoted subscription change.
/api/v1/subscriptions/updateRead a subscription-change operation and its recovery state.
/api/v1/subscriptions/updates/readPage through subscriptions filtered by Customer, Entity, Product, Provider and status.
/api/v1/subscriptions/listPage through purchases and their states.
/api/v1/purchases/listList subscription conflicts and supported next steps without changing a subscription.
/api/v1/subscriptions/conflicts/listRetry a recorded conflict with its original orderId.
/api/v1/subscriptions/conflicts/retryStart, extend or end a trial.
/api/v1/subscriptions/trials/manageRead a recorded trial operation.
/api/v1/subscriptions/trials/readBatch subscription quote (reserved contract).
/api/v1/subscriptions/batches/previewConfirm a subscription batch (reserved contract).
/api/v1/subscriptions/batches/confirmRead a subscription batch (reserved contract).
/api/v1/subscriptions/batches/readAbandon a subscription batch (reserved contract).
/api/v1/subscriptions/batches/abandonRead the invoice templates of this environment.
/api/v1/invoices/templatesPreview invoice amounts and lines without creating an invoice.
/api/v1/invoices/previewAccept an invoice task under a requestId and return its operation.
/api/v1/invoices/createCreate, finalize, send, pay, void or reissue an invoice.
/api/v1/invoices/manageRead an invoice operation by taskId.
/api/v1/invoices/operations/readPage through a Customer's invoices.
/api/v1/invoices/listRead one invoice with its lines.
/api/v1/invoices/readQuote a full or partial refund and its entitlement action; no refund is made.
/api/v1/subscriptions/refunds/previewConfirm a quoted refund; replays never refund twice.
/api/v1/subscriptions/refunds/confirmRead the result of a refund operation.
/api/v1/subscriptions/refunds/readA Customer reads their own usage-billing and auto top-up controls.
/api/v1/billing/controls/readPrepare auto top-up authorization terms for the Customer's explicit consent.
/api/v1/billing/authorizations/prepareRecord the Customer's explicit acceptance of an authorization.
/api/v1/billing/authorizations/confirmChoose which claimed offers apply to a membership.
/api/v1/billing/couponsRevoke an accepted billing authorization.
/api/v1/billing/authorizations/revokeA Customer pages through their own billing invoices.
/api/v1/billing/invoices/readSet a Customer's usage limits, alert thresholds and overage rules from your backend.
/api/v1/billing/controls/managePage through the detail of one billing invoice.
/api/v1/billing/invoices/detailConfirm a billing adjustment (reserved contract).
/api/v1/billing/invoices/confirm-adjustmentA Customer redeems a coupon code into an offer.
/api/v1/offers/redeemList offers available to the current Customer.
/api/v1/offersGrant a coupon from your backend (offers:grant) or let a Customer self-claim (offers:resolve).
/api/v1/offers/grantRecord a verified coupon redemption from your backend, deduplicated by eventId.
/api/v1/offers/redemptionsA Customer redeems a reward or referral code.
/api/v1/rewards/redeemCreate the Customer's referral code in a referral program.
/api/v1/rewards/referral-codeClaim a reward Product (reserved contract).
/api/v1/rewards/product/claimDownload the Feature delivery payload authorized for this identity.
/api/v1/featuresEvaluate Features on the server and return results with their validity.
/api/v1/features/evaluateReport behavior, experiment exposure and Feature-usage events.
/api/v1/eventsAll are sent to POST /api/v1/funnels and selected by the JSON operation field. Server Key starts and server commands need funnels:run and sessions:create; creating a Customer by externalUserId also needs customers:write.
| operation | Credential | Purpose |
|---|---|---|
start | Server Key or Customer Token | Start a Run at a fixed Funnel Version and return its Run Token. |
get | Run Token + original identity proof | Read the Run and its current instruction. |
resume | Run Token + original identity proof | Resume the original Run, keeping accepted work and waits. |
submit | Run Token + original identity proof | Submit input for the current screen. |
back | Run Token + original identity proof | Go back where the position allows it. |
shown | Run Token + original identity proof | Record that a screen was actually displayed. |
close | Run Token + original identity proof | Close the interaction under the Run's stop rules. |
commit_segment | Run Token + original identity proof | Commit a Local segment of pure steps for server verification. |
evaluate | Run Token + original identity proof | Single-node Local evaluation report; new integrations use commit_segment. |
review | Run Token + original identity proof | Read a historical presentation or receipt without resuming. |
decide | Server Key | Request a backend decision for a Customer and attributes. |
read_decision | Server Key | Read the original decision by decisionId. |
evaluate_decision | Server Key | Report a pure evaluation for the original decision. |
feature_config | Server Key | Read Feature configuration authorized for download. |
commit_decision_segment | Server Key | Commit the original decision's Local steps. |
segment_configuration | Server Key | Read evaluation segments of a published Version. |
configuration | Server Key | Read Funnel configuration to check Version and evaluation mode. |
local_configuration | Server Key | Read the configuration used by the Local SDK. |
report_used | Server Key | Record caller-reported adoption, deduplicated by eventId. |
campaign_decide | Server Key | Campaign decision. |
campaign_start | Server Key | Start a Campaign under a cooldown, or return suppression. |
renew_run | Server Key | Rotate a Run Token. |
signal | Server Key | Submit an external event to a waiting Run. |
read_results | Server Key | Read a Run's accepted results. |
resolve_screen | Server Key or identified Customer Token | Resolve resource state and coupon summaries for a Local screen. |
Funnel commands
start
get
resume
submit
back
shown
close
commit_segment
evaluate
commit_segment.review
decide
read_decision
evaluate_decision
feature_config
commit_decision_segment
segment_configuration
configuration
local_configuration
report_used
campaign_decide
campaign_start
renew_run
signal
read_results
resolve_screen
Related: Funnel decision HTTP
| Method | Path | Purpose |
|---|---|---|
| GET | /api/v1/configuration/{environmentId} | Published SDK configuration manifest; supports ETag/304. |
| GET | /api/v1/configuration/{environmentId}/artifacts/{digest} | A public configuration artifact referenced by the manifest, verified by SHA-256. |
| GET | /api/v1/page-experiments/{environmentId} | URL redirect experiment configuration. |
| POST | /api/v1/page-experiments/{environmentId}/events | URL redirect experiment exposures and events; Origin is checked. |
| GET | /api/v1/visual-experiments/{environmentId} | Visual experiment configuration. |
| POST | /api/v1/visual-experiments/{environmentId}/events | Visual experiment exposures and events; Origin is checked. |
Public endpoints without credentials
GET
/api/v1/configuration/{environmentId}GET
/api/v1/configuration/{environmentId}/artifacts/{digest}GET
/api/v1/page-experiments/{environmentId}POST
/api/v1/page-experiments/{environmentId}/eventsGET
/api/v1/visual-experiments/{environmentId}POST
/api/v1/visual-experiments/{environmentId}/events