Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nomos Subscriptions API

The Subscriptions API from Nomos — 3 operation(s) for subscriptions.

Nomos Subscriptions API is one of 12 APIs that Nomos publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification, an AsyncAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 3 paths, and defines 24 schemas. It is described by OpenAPI 3.0.0, at version 2026-05-27.curie.

Requests are made against a single base URL, https://api.nomos.energy.

5 operations 3 paths 24 schemas 2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2026-05-27.curie
Base URL
https://api.nomos.energy
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Nomos Subscriptions API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). It accepts HTTP basic authentication (Basic).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 5
PATCH
/subscriptions/{id}
Update a subscription
1 param body → 200400401402403404405409
GET
/subscriptions/{id}
Retrieve a subscription
1 param → 200400401402403404405409
POST
/subscriptions/{id}/terminate
Terminate a subscription
1 param body → 200400401402403404405409
GET
/subscriptions
List subscriptions
3 params → 200400401402403404405409
POST
/subscriptions
Create a subscription
body → 200400401402403404405409

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are Subscription (19 properties), Meter (7 properties), Address (7 properties), InsertCompanyCustomer (6 properties). Each schema is shown below with its type and property counts.

ErrUnauthorized
object
5 properties 4 required
ErrInternalServerError
object
5 properties 4 required
ErrBadRequest
object
5 properties 4 required
Address
object
7 properties 7 required
Customer
ErrUnprocessableEntity
object
5 properties 4 required
InsertPaymentMethod
object
Attach a new SEPA direct-debit mandate. The new payment method replaces the subscription's current mandate.
2 properties 2 required
ErrPaymentRequired
object
5 properties 4 required
InsertPersonCustomer
object
5 properties 3 required
Meter
object
7 properties 5 required
TerminateSubscriptionResponse
object
2 properties 2 required
Supplier
object
5 properties 5 required
ErrConflict
object
5 properties 4 required
UpdateSubscription
object
3 properties
InsertCompanyCustomer
object
6 properties 5 required
TerminateSubscription
PaymentMethod
object
5 properties 5 required
InsertMeter
object
4 properties 3 required
Subscription
object
19 properties 13 required
InsertAddress
object
New billing address for the subscription
4 properties 4 required
ErrNotFound
object
5 properties 4 required
ErrTooManyRequests
object
5 properties 4 required
ErrForbidden
object
5 properties 4 required
ErrMethodNotAllowed
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nomos-subscriptions-api-openapi.yml Raw ↑

Other APIs Nomos publishes across the network.

Nomos Authentication API
Nomos Customers API
Nomos Events API
Nomos Grid Fee Reductions API
Nomos Invoices API
Nomos Leads API
Nomos Market Partners API
Nomos Plans API
Nomos Prices API
Nomos Smart Meter Orders API
Nomos Usage API