Catalog

5 endpoints in this group. All paths are prefixed with /api/v1.

Endpoints in this group#

• GET /api/v1/catalog/plans — List all plans across all services
• GET /api/v1/catalog/plans/{plan_id} — Get Plan
• GET /api/v1/catalog/services — List Services
• GET /api/v1/catalog/services/{slug} — Get Service
• GET /api/v1/catalog/services/{slug}/plans — Get Service Plans

GET /api/v1/catalog/plans — List all plans across all services {#get-api-v1-catalog-plans}#

Flat plan catalogue across all services.

Useful for clients that need to look up plan names by plan_id without iterating per-service. Defaults to public + active plans only; the include_* flags widen the view for admin tools.

Parameters:

• service_slug (query, string, optional)
• tier (query, string, optional)
• include_inactive (query, boolean, optional)
• include_private (query, boolean, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_list_PlanResponse__ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

GET /api/v1/catalog/plans/{plan_id} — Get Plan {#get-api-v1-catalog-plans-plan-id}#

Parameters:

• plan_id (path, string, required)

Responses:

• 200 — Successful Response. Returns: ApiResponse_PlanResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

GET /api/v1/catalog/services — List Services {#get-api-v1-catalog-services}#

Responses:

• 200 — Successful Response. Returns: ApiResponse_list_ServiceResponse__ — {data, meta}

GET /api/v1/catalog/services/{slug} — Get Service {#get-api-v1-catalog-services-slug}#

Parameters:

• slug (path, string, required)

Responses:

• 200 — Successful Response. Returns: ApiResponse_ServiceDetailResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

GET /api/v1/catalog/services/{slug}/plans — Get Service Plans {#get-api-v1-catalog-services-slug-plans}#

Parameters:

• slug (path, string, required)

Responses:

• 200 — Successful Response. Returns: ApiResponse_list_PlanResponse__ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}