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

Exclaimer Subscriptions API

The Subscriptions API from Exclaimer — 13 operation(s) for subscriptions.

Exclaimer Subscriptions API is one of 9 APIs that Exclaimer 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, an API reference, API documentation, authentication docs, and rate-limit docs.

This API exposes 15 operations across 13 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, https://cloudapi.exclaimer.com/exclaimerapi.

15 operations 13 paths 21 schemas 3 GET4 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://cloudapi.exclaimer.com/exclaimerapi
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Exclaimer Subscriptions API declares 1 security scheme for authenticating requests. An API key is passed in the header as ExApiToken (Exclaimer). By default, every request must be authenticated.

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 3 GET, 4 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 15
PUT
/1.0/subscriptions/{SubscriptionID}/activate-full
Activate Full Subscription
1 param → 204400401404500
POST
/1.0/subscriptionsdeprecated
Add Subscription
body → 200400401403404415500
GET
/1.0/subscriptions
Get Subscriptions
6 params → 200400401415500
POST
/v2.0/subscriptions
Add Subscription V2
body → 200400401403404415500
PUT
/1.0/subscriptions/{SubscriptionID}/deactivate
Deactivate Subscription
1 param → 204400401404415500
PUT
/1.0/subscriptions/{SubscriptionID}/end
End Subscription
1 param → 204400401404415500
POST
/1.0/subscriptions/{SubscriptionID}/migrate
Migrate Subscription
1 param body → 204400401404415500
PUT
/1.0/subscriptions/{SubscriptionID}/reactivate
Reactivate Subscription
1 param body → 204400401404415500
GET
/1.0/subscriptions/{SubscriptionID}
Get Subscription
1 param → 200400401404415500
PUT
/1.0/subscriptions/{SubscriptionID}
Update Subscription
1 param body → 204400401403404415500
GET
/1.0/subscriptions/{SubscriptionID}/history
Get Subscription History
1 param → 200400401415500
PUT
/1.0/subscriptions/{SubscriptionID}/nfr
Change Not For Resale
1 param body → 204400401403404415500
POST
/1.0/subscriptions/{SubscriptionID}/change-owner
Change Subscription Owner
1 param body → 204400401415500
PUT
/1.0/subscriptions/{SubscriptionID}/change-sku
Change Stock Keeping Unit
1 param body → 204400401403404415500
PUT
/1.0/subscriptions/{SubscriptionID}/change-tier
Change Tier
1 param body → 204400401404415500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Subscription (20 properties), AddSubscription (18 properties), AddSubscriptionV2 (15 properties), AddSubscriptionEndUserV2 (8 properties). Each schema is shown below with its type and property counts.

AddSubscriptionResponse
object
2 properties
Subscription
object
20 properties
AddSubscription
object
This request will create a new subscription and adds it to the Exclaimer Cloud service. A new user will be created for the email address provided if one doesn'…
18 properties 3 required
UpdateSubscriptionNFR
object
This request allows you to specify that the subscription is not for resale. A subscription can be changed from being not for resale to a standard subscription,…
2 properties 1 required
SingleSubscriptionResponse
object
1 property
MigrateSubscription
object
This request allows you to assign, transfer, or remove, a reseller and/or end user, from an existing subscription.
2 properties
UpdateSubscriptionDetails
object
This request can be used to update the name and currency assigned to the subscription.
2 properties
AddSubscriptionResellerV2
object
1 property 1 required
SubscriptionNFRDetails
object
2 properties
TierHistory
object
3 properties
SkuHistory
object
3 properties
UpdateSubscriptionOwner
object
This request will assign a different user to be the owner of a subscription. The new owner must already exist against the subscription, and must have the Admin…
2 properties
AddSubscriptionReseller
object
3 properties 3 required
SubscriptionsResponse
object
5 properties
SubscriptionHistoryResponse
object
2 properties
ReactivateSubscription
object
This request will reactivate a previously ended, or deactivated, subscription. The subscription will no longer reside in a dormant state and emails will be imp…
1 property
UpdateSubscriptionSKU
object
This request allows you to use a code to change specific aspects of an existing subscription. N.B. You cannot change from an Office365 subscription to a GSuite…
2 properties 1 required
AddSubscriptionV2
object
This request will create a new subscription using Version 2 of the API. V2 requires SKU and EndUser (with Domain) fields. The SubscriptionProductCode, Tier, NF…
15 properties 5 required
AddSubscriptionEndUserV2
object
8 properties 1 required
AddSubscriptionEndUser
object
3 properties 3 required
UpdateSubscriptionTier
object
This request allows you to change the subscription tier.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exclaimer-subscriptions-api-openapi.yml Raw ↑

Other APIs Exclaimer publishes across the network.

Exclaimer End Users API
Exclaimer Mailboxes API
Exclaimer Miscellaneous API
Exclaimer MSP API
Exclaimer Reference Resources API
Exclaimer Resellers API
Exclaimer Subscription Transfers API
Exclaimer Subscription Users API
Where this information came from

This is an independent, third-party profile of Exclaimer 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.