Farther ShoreDocs
Go to Farther Shore
Getting startedCore conceptsLaunch checklist
ProductsUpstream routingEnvironmentsDeveloper portals
Billing strategiesPlans and limitsSubscribersAPI keys
Gateway enforcementUsage meteringLimits and creditsGateway sharding
Launch a request-counted product15mAdd monthly included usageAdd subscription plus overageCreate a prepaid credits productMeter AI token usageAdd a custom meterIssue and test an API keyDebug a denied requestUpdate product docsPrepare for launch
TroubleshootingGateway response codesMeter namingPlatform docs publishing
Status
Docs/Cookbook/Launch a request-counted product
15m

Launch a request-counted product

Create a simple API product billed by request count.

PreviousGateway shardingNextAdd monthly included usage

On this page

When to use thisStepsExample planTest requestConfirm successCommon mistakes

This recipe creates the simplest useful Farther Shore product: one upstream API, one requests meter, and one plan.

When to use this

Use this recipe when:

  • each API call should count as one billable unit
  • the upstream cost is predictable
  • you want the first product live quickly
  • you do not need token, credit, or custom unit metering yet

Steps

  1. Create a new product in the builder console.
  2. Choose API calls or create a requests meter.
  3. Set the upstream base URL.
  4. Create a starter plan.
  5. Set the included or maximum request amount.
  6. Publish the product.
  7. Create a test subscriber.
  8. Issue a subscriber API key.
  9. Send a request through the gateway.

Example plan

name: Starter
price: "$29 / month"
meter: requests
included: 10000
overage: false

Test request

curl https://<product-host>/v1/health \
  -H "Authorization: Bearer <subscriber-api-key>"

Confirm success

The product is working when:

  • the gateway returns the upstream response
  • the upstream receives the request
  • usage appears for the requests meter
  • a missing API key is denied
  • a revoked API key is denied

Common mistakes

ProblemFix
Usage does not appearConfirm the request went through the gateway, not directly to upstream.
Gateway returns invalid keyUse the subscriber API key, not a builder token.
Request reaches wrong upstreamRecheck the product upstream base URL.