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/Monetize/Subscribers

Subscribers

Manage customers, subscriptions, lifecycle states, and access.

PreviousPlans and limitsNextAPI keys

On this page

Subscriber lifecycleSubscription and API key relationshipCommon subscriber operationsTesting subscriber accessSupport guidance

Subscribers are the customers using a product. A subscriber's active subscription determines which plan the gateway enforces.

Subscriber lifecycle

StateMeaning
NewSubscriber exists but may not have active access yet.
ActiveSubscriber has an active subscription and can use valid API keys.
Past duePayment or billing state needs attention. Access depends on product policy.
CancelledSubscription is no longer active. Gateway access should stop.
SuspendedAccess is intentionally blocked.

Subscription and API key relationship

API keys identify requests. Subscriptions determine access.

A valid key is not enough by itself. The gateway also checks the subscriber's subscription and plan state before forwarding traffic.

Common subscriber operations

Product owners commonly need to:

  • create a test subscriber
  • issue an API key
  • move a subscriber to a different plan
  • revoke a key
  • inspect usage
  • troubleshoot denied requests
  • cancel or suspend access

Testing subscriber access

Use a real subscriber key when testing a live product:

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

Then confirm:

  • the request reaches the upstream
  • usage is recorded on the expected subscriber
  • plan limits behave as configured

Support guidance

When a subscriber reports access trouble, ask for:

  • product hostname
  • approximate request time
  • response status and code
  • whether the key was newly created or recently rotated
  • expected plan

Do not ask subscribers to send full API keys in support channels.