Skip to content

10.5 Read API

Sprint: Sprint 10 - Usage Metering
Feature ID: 10.5
Subtasks: 10.5.1

Objective

Deliver "Read API" within Sprint 10 - Usage Metering.

Dependencies

Aggregated from the subtasks below (prerequisite task IDs and enablers):

  • 10.3.2

Subtasks

10.5.1 Quota and history endpoints

  • ID: 10.5.1
  • Title: Implement quota and usage-history read endpoints
  • Description: GET /api/v1/usage/subscriptions/{id}/quota (remaining minutes/sms/mb) and GET /api/v1/usage/subscriptions/{id}/history?from=...&to=... returning ApiResult with pagination (FR-18).
  • Business Purpose: Near-real-time quota visibility for subscribers (FR-18).
  • Inputs: FR-18, analysis Section 8.5.
  • Outputs: Queries + endpoints.
  • Acceptance Criteria:
  • The quota endpoint reflects decrements within the freshness target; history returns records in the requested range, paginated.
  • Dependencies: 10.3.2
  • Complexity: S

Acceptance Criteria

Each subtask above carries its own objective, testable acceptance criteria. This feature is complete when every subtask's acceptance criteria are met.

Deliverables

  • Queries + endpoints.

Definition of Done

  • All subtasks (10.5.1) completed and their acceptance criteria verified.
  • All listed dependencies satisfied.
  • Build and tests green per the global conventions in ../README.md (Section 3).