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

Invoiced Subscriptions API

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

Invoiced Subscriptions API is one of 9 APIs that Invoiced 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 3 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://api.invoiced.com, https://api.sandbox.invoiced.com.

6 operations 3 paths 1 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.invoiced.com
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Invoiced Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. Use your Invoiced API key as the username and leave the password blank. API keys are created under Settings - Developers - API Keys.

Paths & Operations 6

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

Subscriptions 6
GET
/subscriptions
List all subscriptions.
listSubscriptions 3 params → 200
POST
/subscriptions
Create a new subscription.
createSubscription body → 201
POST
/subscriptions/preview
Preview a subscription without persisting any data.
previewSubscription body → 200
GET
/subscriptions/{id}
Retrieve a subscription.
getSubscription 1 param → 200
PATCH
/subscriptions/{id}
Update a subscription.
updateSubscription 1 param body → 200
DELETE
/subscriptions/{id}
Cancel a subscription.
cancelSubscription 1 param → 204

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Subscription (18 properties). Each schema is shown below with its type and property counts.

Subscription
object
18 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

invoiced-subscriptions-api-openapi.yml Raw ↑

Other APIs Invoiced publishes across the network.

Invoiced Credit Notes API
Invoiced Customers API
Invoiced Estimates API
Invoiced Events API
Invoiced Invoices API
Invoiced Items API
Invoiced Payments API
Invoiced Plans API