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

Notyfi billing API

The billing API from Notyfi — 3 operation(s) for billing.

Notyfi billing API is one of 5 APIs that Notyfi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 1.2.0.

Requests are made against a single base URL, https://api.notyfi.com.

3 operations 3 paths 16 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.2.0
Base URL
https://api.notyfi.com/api/v1
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Notyfi billing API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Api-Key (apiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — Notyfi API key: Authorization: Bearer notyfimk...
  • apiKeyAuth — Notyfi API key as X-Api-Key.

Paths & Operations 3

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

billing 3
GET
/api/v1/billing
Current plan, limits, and tracker usage
billing_status_api_v1_billing_get 3 params → 200401403409429503422
POST
/api/v1/billing/checkout
Create or resume a Stripe-hosted Pro Checkout session
billing_checkout_api_v1_billing_checkout_post 3 params body → 201401403409429503422
POST
/api/v1/billing/portal
Create a short-lived Stripe Customer Portal session
billing_portal_api_v1_billing_portal_post 3 params → 200401403409429503422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BillingStatus (8 properties), NotyfiAccountInfo (7 properties), NotyfiNotificationEmailInfo (6 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

NotyfiNotificationEmailInfo
object
6 properties 2 required
ErrorBody
object
3 properties 2 required
BillingUsage
object
2 properties
BillingPortalSession
object
1 property 1 required
HTTPValidationError
object
1 property
BillingCheckoutCreate
object
Start hosted Checkout for the one public paid plan. The client chooses a logical plan, never a Stripe Price ID or redirect URL; both are server-owned.
1 property
ValidationError
object
5 properties 3 required
NotyfiWorkspaceFolder
object
3 properties 2 required
NotyfiWorkspace
object
2 properties
NotyfiAccountInfo
object
The consumer identity bound to the access-token subject. email is populated only from a separately verified, same-sub Cognito ID token. It is never accepted fr…
7 properties 1 required
BillingPlan
string
Error
object
The single error response shape for every 4xx/5xx on the contract.
1 property 1 required
BillingCheckoutSession
object
2 properties 1 required
BillingStatus
object
8 properties 4 required
BillingLimits
object
3 properties 3 required
BillingCadence
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

notyfi-billing-api-openapi.yml Raw ↑

Other APIs Notyfi publishes across the network.

Notyfi account API
Notyfi keys API
Notyfi trackers API
Notyfi webhooks API