Domains / Billing and Payments/ API Endpoint

Subscription API

REST API for subscription plan management, billing cycle control, and invoice retrieval.

API Endpoint Application active

The Subscription API manages subscription lifecycle including plan selection, upgrades, and billing history.

Endpoints

  • POST /api/v1/subscriptions — Create subscription
  • GET /api/v1/subscriptions/{id} — Get subscription details
  • PUT /api/v1/subscriptions/{id}/plan — Change plan
  • GET /api/v1/subscriptions/{id}/invoices — List invoices

Relationships

◇ Composes outgoing 1
Target Element Element Type
Billing Worker Software Subsystem
◇ Part of incoming 1
Source Element Element Type
Billing Worker Software Subsystem
→ Served by incoming 10
Source Element Element Type
Invoice Generated Domain Event
Metric Baseline Updated Domain Event
Payment Failed Domain Event
Payment Method Updated Domain Event
Payment Refunded Domain Event
Plan Upgraded Domain Event
Subscription Cancelled Domain Event
Subscription Renewed Domain Event
Tenant Deactivated Domain Event
Usage Threshold Exceeded Domain Event

Architecture Context

Diagrams

Not yet referenced in any diagram

Properties

Type API Endpoint
Layer Application
Domain Billing and Payments
Status active
Owner Billing Team

Additional Metadata

Protocol REST/JSON
Archimate Type application-interface
Togaf Type Information System Service

Meta Model

Business
Organization
Application current
Technology

Actions