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

Suger Entitlement API

Access to Entitlement resources

Suger Entitlement API is one of 11 APIs that Suger publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entitlement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 17 operations across 15 paths, and defines 95 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.suger.cloud.

17 operations 15 paths 95 schemas 1 DELETE4 GET4 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.suger.cloud
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Suger Entitlement API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (APIKeyAuth).

  • APIKeyAuth — API Key for authorization in format of .

Paths & Operations 17

Across 15 paths, the API surfaces 17 operations — 1 DELETE, 4 GET, 4 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Entitlement 17

Access to Entitlement resources

GET
/org/{orgId}/entitlement
List Entitlements
ListEntitlements 9 params → 200400500
POST
/org/{orgId}/entitlement
Create Entitlement
CreateEntitlement 1 param body → 200400500
GET
/org/{orgId}/entitlement/{entitlementId}
Get Entitlement
GetEntitlement 2 params → 200400404500
POST
/org/{orgId}/entitlement/{entitlementId}/addCredit
Add Entitlement Credit
AddEntitlementCredit 2 params body → 200400500
POST
/org/{orgId}/entitlement/{entitlementId}/addon
Apply Addon To Entitlement
ApplyAddonToEntitlement 2 params body → 200400500
POST
/org/{orgId}/entitlement/{entitlementId}/approve
Approve Entitlement
ApproveEntitlement 2 params → 200400404500
POST
/org/{orgId}/entitlement/{entitlementId}/cancel
Cancel Entitlement
CancelEntitlement 2 params → 200400404500
POST
/org/{orgId}/entitlement/{entitlementId}/divideCommit
Divide Entitlement Commit
DivideEntitlementCommit 2 params body → 200400500
PATCH
/org/{orgId}/entitlement/{entitlementId}/entitlementName
Update Entitlement Name
UpdateEntitlementName 2 params body → 200400500
GET
/org/{orgId}/entitlement/{entitlementId}/entitlementTerm
List Entitlement Terms
ListEntitlementTerms 2 params → 200400500
DELETE
/org/{orgId}/entitlement/{entitlementId}/entitlementTerm/{entitlementTermId}
Delete Entitlement Term
DeleteEntitlementTerm 3 params → 200400500
GET
/org/{orgId}/entitlement/{entitlementId}/entitlementTerm/{entitlementTermId}
Get Entitlement Term
GetEntitlementTerm 3 params → 200400500
PATCH
/org/{orgId}/entitlement/{entitlementId}/metaInfo
Update Entitlement Meta Info
UpdateEntitlementMetaInfo 2 params body → 200400500
PATCH
/org/{orgId}/entitlement/{entitlementId}/priceModel
Update Entitlement Price Model
UpdateEntitlementPriceModel 2 params body → 200400500
POST
/org/{orgId}/entitlement/{entitlementId}/scheduleCancellation
Schedule Entitlement Cancellation
ScheduleEntitlementCancellation 2 params body → 200400500
PATCH
/org/{orgId}/entitlement/{entitlementId}/seat
Update Seat For The Active AZURE Subscription
UpdateEntitlementSeat 3 params → 200400500
POST
/org/{orgId}/entitlement/{entitlementId}/unscheduleCancellation
Unschedule Entitlement Cancellation
UnscheduleEntitlementCancellation 2 params → 200400500

Schemas 95

The contract defines 95 schemas that model the data the API accepts and returns. The most detailed are EntitlementInfo (36 properties), WorkloadMetaInfo (29 properties), GcpMarketplaceEntitlement (27 properties), NotificationEvent (24 properties). Each schema is shown below with its type and property counts.

AwsRenewalOfferType
string
BillableDimension
object
17 properties
client.DescribeInstanceResponseBodyModules
object
1 property
SnowflakeMarketplaceOffer
object
22 properties
GcpMarketplaceEntitlementState
string
GcpMarketplaceProductUsageFee
object
3 properties
AzureIncludedBaseQuantity
object
3 properties
PriceModelTieredPercentageConfig
object
4 properties
DivideEntitlementCommitParams
object
2 properties
AzureMarketplaceSubscriptionStatus
string
SnowflakeMarketplacePlanInstallment
object
2 properties
CancellationScheduleType
string
TrackEventActionType
string
PriceModelMatrixConfigGroup
object
2 properties
CommitDimension
object
The commit dimension. There may be one or more commit dimensions defined in single product, offer or entitlement.
15 properties
AzureTerm
object
4 properties
EntitlementStatus
string
SnowflakeMarketplacePlanInstallmentSchedule
object
3 properties
PriceModelVolumeConfig
object
3 properties
PriceModelPercentage
object
2 properties
CancellationSchedule
object
4 properties
PriceModelBulk
object
2 properties
types.Entitlement
object
5 properties
TrialConfig
object
2 properties
BillingCycle
string
AwsMarketplaceAgreementV2
object
11 properties
client.DescribeOrderResponseBodySupplierTelephones
object
1 property
WorkloadEntitlement
object
21 properties
EntitlementInfo
object
36 properties
GcpPriceValue
object
3 properties
client.DescribeOrderResponseBodyInstanceIds
object
1 property
AwsProductDimension
object
8 properties
BillingAddonRecord
object
5 properties
PriceModelMatrix
object
2 properties
types.EntitlementValue
object
4 properties
AwsMarketplaceAgreementStatus
string
AzureMarketplaceSubscription
object
21 properties
BillingMinimumCommitScope
string
SnowflakeMarketplaceOfferPaymentTerms
object
2 properties
NotificationEventAction
string
GcpMarketplacePriceModel
string
NotificationEvent
object
24 properties
client.DescribeInstanceResponseBodyModulesModule
object
4 properties
AzureADIdentifier
object
9 properties
GcpMarketplaceProductSubscriptionPlan
object
2 properties
PartnerService
string
BillingDiscount
object
2 properties
PaymentInstallment
object
6 properties
NotificationEventStatus
string
NotificationChannel
string
UpdateEntitlementPriceModelParams
object
3 properties
CommitDimensionType
string
client.DescribeInstanceResponseBodyModulesModulePropertiesProperty
object
5 properties
client.DescribeInstanceResponseBodyModulesModulePropertiesPropertyPropertyValues
object
1 property
github_com_sugerio_marketplace-service_pkg_legacy_rds-db_lib.UpdateEntitlementNameParams
object
3 properties
EntitlementTermInfo
object
5 properties
Partner
string
UsageCount
object
3 properties
client.DescribeInstanceResponseBody
object
20 properties
EntityType
string
PriceModelMatrixProperty
object
2 properties
Contact
object
3 properties
client.DescribeInstanceResponseBodyModulesModulePropertiesPropertyPropertyValuesPropertyValue
object
7 properties
client.DescribeOrderResponseBody
object
22 properties
ValueType
string
WorkloadEntitlementTerm
object
20 properties
GcpMarketplaceProductPriceInfo
object
4 properties
AuditingEventPriority
string
GcpMarketplaceEntitlement
object
27 properties
PriceModelCategory
string
BillingDiscountType
string
GcpMarketplaceConsumer
object
1 property
WorkloadMetaInfo
object
29 properties
MeteringDimension
object
The dimension to meter usage in entitlement.
13 properties
PriceModelTiered
object
1 property
LastModifiedBy
object
4 properties
PaymentScheduleType
string
PriceModelBasic
object
1 property
TimeUnit
string
TrackEvent
object
3 properties
AddEntitlementCreditResponse
object
5 properties
EntitlementTermType
string
CreateEntitlementParams
object
5 properties
GcpPriceTier
object
3 properties
GcpMarketplaceProductFeatureValue
object
4 properties
EulaType
string
client.DescribeInstanceResponseBodyRelationalData
object
1 property
PriceModelVolume
object
1 property
AddEntitlementCreditParams
object
4 properties 3 required
client.DescribeInstanceResponseBodyModulesModuleProperties
object
1 property
GcpMarketplaceProductPurchaseOptionSpec
object
5 properties
PriceModelTieredPercentage
object
1 property
AwsChannelPartner
object
2 properties
SnowflakeMarketplaceOfferTermsOfService
object
2 properties
PriceModelTieredConfig
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

suger-entitlement-api-openapi.yml Raw ↑

Other APIs Suger publishes across the network.

Suger API API
Suger Billing API
Suger Buyer API
Suger Contact API
Suger Metering API
Suger Notification API
Suger Offer API
Suger Product API
Suger Report API
Suger Support API
Where this information came from

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