How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Upsun Subscriptions API

Each project is represented by a subscription that holds the plan information.These endpoints can be used to go to a larger plan, add more storage, or subscribe tooptional features.

Upsun Subscriptions API is one of 50 APIs that Upsun publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 13 operations across 9 paths, and defines 16 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, {schemes}://api.upsun.com.

13 operations 9 paths 16 schemas 1 DELETE9 GET2 PATCH1 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.upsun.com
Authentication
OAuth 2.0, OAuth 2.0
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

Upsun Subscriptions API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. It supports OAuth 2.0 (OAuth2Admin) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 13

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

Subscriptions 13

Each project is represented by a subscription that holds the plan information. These endpoints can be used to go to a larger plan, add more storage, or subscribe to optional featu…

GET
/subscriptions/{subscriptionId}/can-update
Checks if the user is able to update a project.
can-update-subscription 5 params → 200
GET
/organizations/{organization_id}/subscriptions/estimate
Estimate the price of a new subscription
estimate-new-org-subscription 6 params → 200403404
GET
/organizations/{organization_id}/subscriptions/can-create
Checks if the user is able to create a new project.
can-create-new-org-subscription 1 param → 200403404
GET
/organizations/{organization_id}/subscriptions/{subscription_id}/estimate
Estimate the price of a subscription
estimate-org-subscription 7 params → 200403
GET
/organizations/{organization_id}/subscriptions/{subscription_id}/current_usage
Get current usage for a subscription
get-org-subscription-current-usage 4 params → 200403
GET
/organizations/{organization_id}/subscriptions/{subscription_id}/addons
List addons for a subscription
list-subscription-addons 2 params → 200403
GET
/organizations/{organization_id}/alerts/subscriptions/{subscription_id}/usage
Get usage alerts
get-subscription-usage-alerts 2 params → 200403404
PATCH
/organizations/{organization_id}/alerts/subscriptions/{subscription_id}/usage
Update usage alerts.
update-subscription-usage-alerts 2 params body → 200403404
GET
/organizations/{organization_id}/subscriptions
List subscriptions
list-org-subscriptions 11 params → 200403404
POST
/organizations/{organization_id}/subscriptions
Create subscription
create-org-subscription 1 param body → 201400403404
GET
/organizations/{organization_id}/subscriptions/{subscription_id}
Get subscription
get-org-subscription 2 params → 200403404
PATCH
/organizations/{organization_id}/subscriptions/{subscription_id}
Update subscription
update-org-subscription 2 params body → 200400403404
DELETE
/organizations/{organization_id}/subscriptions/{subscription_id}
Delete subscription
delete-org-subscription 2 params → 204403404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Subscription (24 properties), SubscriptionCurrentUsageObject (13 properties), UsageGroupCurrentUsageProperties (9 properties), StringFilter (8 properties). Each schema is shown below with its type and property counts.

ProjectTimeZone
string
Timezone of the project.
UsageAlert
object
The usage alert for a subscription.
6 properties
OwnerInfo
object
Project owner information that can be exposed to collaborators.
3 properties
SubscriptionCurrentUsageObject
object
A subscription's usage group current usage object.
13 properties
UsageGroupCurrentUsageProperties
object
Current usage info for a usage group.
9 properties
Error
object
5 properties
Link
object
A hypermedia link to the {current, next, previous} set of items.
1 property
Subscription
object
The subscription object.
24 properties
DateTimeFilter
object
7 properties
ProjectPlan
string
The project plan.
ListLinks
object
3 properties
ProjectOptions
object
The project options object.
5 properties
EstimationObject
object
A price estimate object.
6 properties
StringFilter
object
8 properties
ProjectTitle
string
The title of the project.
SubscriptionAddonsObject
object
The list of available and current addons for the license.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upsun-subscriptions-api-openapi.yml Raw ↑

Other APIs Upsun publishes across the network.

Upsun Add-ons API
Upsun Alerts API
Upsun API Tokens API
Upsun Autoscaling API
Upsun Cert Management API
Upsun Connections API
Upsun Deployment API
Upsun Deployment Target API
Upsun Discounts API
Upsun Domain Management API
Upsun Environment Activity API
Upsun Environment API
Where this information came from

This is an independent, third-party profile of Upsun Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.