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

AppDirect Subscriptions API

The Subscriptions API from AppDirect — 19 operation(s) for subscriptions.

AppDirect Subscriptions API is one of 75 APIs that AppDirect 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.

This API exposes 24 operations across 19 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version v296.0-SNAPSHOT.

Requests are made against 2 base URLs: https://marketplace.appdirect.com/api, https://virtserver.swaggerhub.com.

24 operations 19 paths 47 schemas 2 DELETE12 GET1 PATCH5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v296.0-SNAPSHOT
Base URL
https://marketplace.appdirect.com/api
Resource Areas
1

Paths & Operations 24

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

Subscriptions 24
POST
/account/v2/subscriptions/{subscriptionUuid}/reactivationRequest
Subscription reactivation request
resource_Subscription_requestSubscriptionReactivation_POST 1 param → 200401
GET
/account/v2/subscriptions/{subscriptionUuid}/saml/certificate
Read subscription SAML Certificate
resource_Subscription_readSamlCertificate_GET 1 param → 200401500
GET
/account/v2/subscriptions/{subscriptionUuid}/saml
Read SAML metadata for subscription
resource_Subscription_readSamlInfo_GET 1 param → 200401404
GET
/billing/v1/companies/{companyId}/subscriptions
List all subscriptions for a company
resource_Other_readCompanySubscriptions_GET 16 params → 200404
PUT
/billing/v1/companies/{companyId}/users/{userId}/subscriptions/{subscriptionId}
Change subscription details
resource_Other_changeSubscription_PUT 4 params body → 200400404409
GET
/billing/v1/companies/{companyId}/users/{userId}/subscriptions
List all subscriptions for a user
resource_Other_readUserSubscriptions_GET 17 params → 200404
POST
/billing/v1/companies/{companyId}/users/{userId}/subscriptions
Create a subscription
resource_Other_createSubscription_POST 3 params body → 201400404409
PUT
/billing/v1/companies/{companyId}/users/{userId}/subscriptions/{subscriptionId}/preview
Preview changed subscription details
resource_Other_previewChangeSubscription_PUT 3 params body → 200400404
POST
/billing/v1/companies/{companyId}/users/{userId}/subscriptions/preview
Preview create a subscription
resource_Other_previewCreateSubscription_POST 2 params body → 201400404
GET
/billing/v1/subscriptions/{subscriptionId}/orders
List all purchase orders for a subscription
resource_Other_readSubscriptionPurchaseOrders_GET 15 params → 200
PUT
/billing/v1/subscriptions/{subscriptionId}/addons/{addonInstanceUuid}
Update an add-on instance
resource_Subscription_changeAddonInstance_PUT 2 params body → 200404
DELETE
/billing/v1/subscriptions/{subscriptionId}/addons/{addonInstanceUuid}
Delete an add-on instance
resource_Subscription_cancelAddonInstance_DELETE 2 params → 204404
GET
/billing/v1/subscriptions
List all subscriptions
resource_Subscription_readSubscriptions_GET 15 params → 200404
GET
/billing/v1/subscriptions/{subscriptionId}/payments
List all payments for a subscription
resource_Subscription_readSubscriptionPayments_GET 9 params → 200404
GET
/billing/v1/subscriptions/{subscriptionId}
Retrieve a subscription
resource_Subscription_readSubscription_GET 1 param → 200404
DELETE
/billing/v1/subscriptions/{subscriptionId}
Request cancellation
resource_Subscription_cancelSubscription_DELETE 2 params → 202204404
PATCH
/billing/v1/subscriptions/{subscriptionId}
Update subscriptions
resource_Other_updateSubscription_PATCH 1 param body → 200400404412
GET
/billing/v1/subscriptions/{subscriptionId}/addons
Read addon instances for a subscription
resource_Subscription_readAddonInstances_GET 4 params → 200404
POST
/billing/v1/subscriptions/{subscriptionId}/addons
Create an add-on instance
resource_Subscription_createAddonInstance_POST 1 param body → 201400404409
GET
/billing/v1/subscriptions/{subscriptionId}/invoices
List all invoices for a subscription
resource_Subscription_readSubscriptionInvoices_GET 9 params → 200404
POST
/billing/v1/subscriptions/{subscriptionId}/addons/preview
Preview creation of an addon instance for a subscription
resource_Subscription_previewCreateAddonInstance_POST 1 param body → 200400404
PUT
/billing/v1/subscriptions/{subscriptionId}/addons/{addonInstanceUuid}/preview
Preview change of an addon instance for a subscription
resource_Subscription_previewChangeAddonInstance_PUT 2 params body → 200400404
GET
/billing/v1/subscriptions/{subscriptionId}/previewCancel
Preview subscription cancellation
resource_Subscription_previewCancelSubscription_GET 1 param → 200404
GET
/api/v1/org-subscriptions/{publicId}
Get an organization subscription by public ID
getOrgSubscriptionByPublicId 1 param → 200400403404

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are OrgSubscriptionDto (24 properties), PriceWS (22 properties), SubscriptionWS (18 properties), OrderLineWS (16 properties). Each schema is shown below with its type and property counts.

PaymentWS
SubscriptionUpdateWS
objectnull
4 properties 1 required
PricingUnit
string
OrderContractRenewalWS
objectnull
2 properties
SubscriptionMetadataDto
object
2 properties
OrderTerminationFeeWS
objectnull
7 properties
OrgMembershipTypeDto
string
ContractWS
object
Contract associated to a payment plan
10 properties
OrderContractWS
objectnull
15 properties
OrderLineWS
object
16 properties
CompanyEntitlementStatus
stringnull
OrgSubscriptionPricingPlanDto
string
PaymentPlanWS
object
Payment plan for a product edition
12 properties
Currency
string
Supported currencies for the system
OrgSubscriptionStatusDto
string
OrgSubscriptionTypeDto
string
OrderWS
TerminationFeeWS
objectnull
Fee incurred during a termination of a product subscription
4 properties
PaymentMethod
string
The supported payment methods
DurationWS
objectnull
Contract duration
2 properties
AttributeType
string
CompanyEntitlementSuspensionReason
string
GatewayResponseWS
object
4 properties
AddonInstanceWS
objectnull
6 properties
PlanCostWS
object
Plan cost
14 properties
UsageLimitsDto
object
3 properties 3 required
TokenLimitsDto
object
2 properties 2 required
OrgSubscriptionDto
object
24 properties 24 required
InvoiceStatus
string
ProductDiscountDetailsWS
objectnull
Discount detail on a product pricing
8 properties
OrderUnitContractWS
objectnull
4 properties
OrderDetailedListingWS
objectnull
2 properties
InvoiceListingWS
BaseOrderWS
PaymentResult
string
ResourceSupport
objectnull
Resource links
1 property
ParameterWS
object
2 properties
SubscriptionListingWS
ChannelCustomAttributeWS
object
4 properties
SubscriptionCustomAttributeWS
object
A subscription custom attribute, as defined in the marketplace at Manage Marketplace Settings Custom Attributes Subscription Custom Attributes
2 properties
SubscriptionWS
objectnull
18 properties
LinkWS
objectnull
2 properties
SubscriptionProcessorTypeDto
string
OrderListingWS
HalResourceSupport
PriceWS
objectnull
Price information in different currencies
22 properties
Link
objectnull
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

appdirect-subscriptions-api-openapi.yml Raw ↑

Other APIs AppDirect publishes across the network.

AppDirect AI Embed API
AppDirect AI Management API
AppDirect AI Models API
AppDirect AI User Inputs API
AppDirect Answer API
AppDirect API Keys API
AppDirect AppResellerAccount API
AppDirect AppResellerAssignment API
AppDirect AppResellerCatalog API
AppDirect AppResellerCompanyAssociation API
AppDirect AppResellerLeads API
AppDirect AppResellerOpportunities API
Where this information came from

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