Account1

Adhoc Retrievers3

Agent Sessions11

Alerts16

Analytics41

Annotations9

Apps34

Batches4

Bucket Batches22

Bucket Objects10

Bucket Syncs15

Bucket Uploads7

Buckets7

BYO Documents5

Cluster Executions7

Cluster Triggers8

Clusters9

Collection Documents19

Collection Lifecycle2

Collection Schema1

Collection Taxonomies1

Collections14

Custom Models8

Data Subject Access Requests3

Discovery4

Document Lineage3

Documents6

Events1

Extractor Publishing5

Extractors5

Feature Extractors2

Feature Search1

Features1

Health4

Inference1

Manifest7

Marketplace14

Models6

Namespace Clone1

Namespace Extractors2

Namespace Migrations7

Namespace Snapshots6

Namespaces10

Notifications12

Onboarding2

Organization API Keys5

Organization Audit5

Organization Billing22

Organization Connections8

Organization Infrastructure1

Organization Secrets4

Organization Targets1

Organization Usage3

Organization Users5

Organizations3

Pricing1

Public Apps API5

Public Extractor Marketplace2

Public Notifications API1

Public Retriever API7

Public Templates API8

Published Retrievers8

Quickstart1

Resource Search1

Retriever API Keys3

Retriever Benchmarks4

Retriever Evaluations9

Retriever Interactions5

Retriever Stages1

Retrievers15

Scaffold Templates3

Signup1

Source Adapter2

Support14

Tasks3

Taxonomies13

Taxonomy Analytics6

Templates23

Triggers10

Webhooks5

Organization Billing

Redeem Promo

Changed on Oct 9, 2026

Redeem a promo code on a FRESH org — no Checkout, no card.

A promo code lets you continue without entering a card. This creates the subscription server-side with the coupon attached (the self-serve twin of the manual comp flow), stamps metadata.organization_id so the subscription webhook grants tier + POC cap, and sets the org's plan fields inline so the user continues IMMEDIATELY (no webhook-latency paywall).

Only codes whose window bills $0 (percent_off=100 — every POC code by validated shape) can start service card-less: a partial discount with no payment method would generate a FAILING first invoice (service cut + dunning — strictly worse than the card form; the uncollectable shape POC-PROMO-CAP-2026-07-17 exists to prevent). Partial codes get a clear redirect to checkout, where the discount still applies. Card-ask happens at coupon end (finances' T-7d lifecycle).

Every failure carries a reason — never a silent no-op.

post/v1/organizations/billing/redeem-promo

Request

Base URL: https://api.mixpeek.com
URL: https://api.mixpeek.com/v1/organizations/billing/redeem-promo
Auth: HTTP bearer

Request body

codestring required

planstring

Plan slug to start on the comped window (product_tier, e.g. managed_build). Must be self-serve and match the code's product restriction.

Response

Successful Response

redeemedboolean required

codestring required

planstring required

account_typestring required

subscription_idstring required

poc_usage_cap_centsinteger nullable

POC promo usage ceiling (cents), granted via the subscription webhook (cap_source=poc_promo:*).

duration_in_monthsinteger nullable

Changes

Oct 9, 202661a175e8eb9a Revision changes
- warning
  removed the optional property from the response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Aug 9, 20265d4c905106b4 Revision changes
- info
  the endpoint scheme security BearerAuth was added to the API

Operation history (3 revisions)