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

Narmi subscriptions API

The subscriptions API from Narmi — 2 operation(s) for subscriptions.

Narmi subscriptions API is one of 44 APIs that Narmi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.sandbox.narmi.dev/.

6 operations 2 paths 7 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.sandbox.narmi.dev/
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Narmi subscriptions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 6

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

subscriptions 6
GET
/v1/subscriptions/
List subscriptions
subscriptions_list 2 params → 200404
POST
/v1/subscriptions/
Create a subscription
subscriptions_create body → 200422
GET
/v1/subscriptions/{uuid}/
Retrieve a subscription
subscriptions_retrieve 1 param → 200404
PUT
/v1/subscriptions/{uuid}/
Update a subscription
subscriptions_update 1 param body → 200404422
PATCH
/v1/subscriptions/{uuid}/
Modify subscription
subscriptions_partial_update 1 param body → 200404
DELETE
/v1/subscriptions/{uuid}/
Delete a subscription
subscriptions_destroy 1 param → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Subscription (9 properties), PatchedSubscriptionRequest (5 properties), SubscriptionRequest (5 properties), PaginatedSubscriptionList (3 properties). Each schema is shown below with its type and property counts.

NotFoundError
object
2 properties 1 required
SubscriptionRequest
object
5 properties 1 required
PaginatedSubscriptionList
object
3 properties 2 required
SubscriptionResponse
object
1 property 1 required
Subscription
object
9 properties 1 required
PatchedSubscriptionRequest
object
5 properties 1 required
ObjectNotFoundError
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

narmi-subscriptions-api-openapi.yml Raw ↑

Other APIs Narmi publishes across the network.

Narmi account balances API
Narmi accounts API
Narmi ach companies API
Narmi ach destinations API
Narmi ach import API
Narmi ach payments API
Narmi ach transfers API
Narmi alerts API
Narmi automatic savings enrollment API
Narmi card linked offers API
Narmi cards API
Narmi data access management API