Subscription Usage Entitlements
subscriptionUsageEntitlements Based on latest (2026.09)
Create, change, delete and look up Subscription Usage Entitlements, with entitlement plans. Actions include create usage entitlement.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
UsageEntitlementId- Required on create
BalanceProfileNameUsageEntitlementNumber- At a glance
- 35 fields2 finders6 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/subscriptionUsageEntitlements?fields=Action,BalanceProfileId,BalanceProfileName,BalanceProfileNumber,BusinessUnitId&limit=25&onlyData=true
{
"items": [
{
"Action": "<string>",
"BalanceProfileId": 0,
"BalanceProfileName": "<string, max 120>",
"BalanceProfileNumber": "<string, max 120>",
"BusinessUnitId": 0
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 35
| Attribute | Type | Use |
|---|---|---|
Action | text | Optional on createUpdatable |
BalanceProfileId | number | Optional on createSearchable |
BalanceProfileName | text · max 120 | Required on createUpdatableSearchable |
BalanceProfileNumber | text · max 120 | Optional on createSearchable |
BusinessUnitId | number | Optional on createSearchable |
BusinessUnitName | text · max 240 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EndDateActive | date | Read-onlySearchable |
EntitlementPlanName | text · max 120 | Read-onlySearchable |
EntitlementPlanNumber | text · max 120 | Read-onlySearchable |
InventoryItemId | number | Optional on createSearchable |
ItemNumber | text · max 300 | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
NegotiatedFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ObjectVersionNumber | number | Optional on createUpdatableSearchable |
OrganizationId | number | Optional on createSearchable |
Precedence | number | Optional on createUpdatableSearchable |
PriceListId | number | Optional on createSearchable |
PriceListItemId | number | Read-onlySearchable |
PriceListName | text · max 80 | Read-onlySearchable |
PriceUnitOfMeasure | text · max 25 | Read-onlySearchable |
PriceUnitOfMeasureCode | text · max 3 | Optional on createSearchable |
RatePlanId | number | Optional on createSearchable |
RatePlanName | text · max 80 | Optional on createSearchable |
RatePlanNumber | text · max 120 | Optional on createSearchable |
RatingModel | text · max 30 | Read-onlySearchable |
RatingModelMeaning | text · max 80 | Read-onlySearchable |
StartDateActive | date | Read-onlySearchable |
Status | text · max 30 · default ORA_OSS_DRAFT | Read-onlySearchable |
SummarizedRatingFlag | yes/no · max 1 · default false | Read-onlySearchable |
UsageEntitlementId | number | Optional on createSearchable |
UsageEntitlementNumber | text · max 120 | Required on createSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
StandardUsageEntitlementsFinderUsageEntitlementAltKey·UsageEntitlementNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 6
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/subscriptionUsageEntitlements/{UsageEntitlementId}/child/<name>. Add them to a GET with expand.
entitlementPlansGET · POST · PATCH · DELETE Subscription Usage Entitlement Plans · 14 fields · 1 findersBalanceProfileIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberRatePlanIdRatingModelSummarizedRatingFlagUsageEntitlementPlanDescriptionUsageEntitlementPlanIdUsageEntitlementPlanNameUsageEntitlementPlanNumberallowancesGET · POST · PATCH · DELETE Subscription Entitlement Plan Details · 52 fields · 1 findersAdditionalPoolingFilterAllowanceAllowanceChargeDefinitionIdAllowancePeriodicityAllowancePeriodicityNameAllowancePoolingGroupAllowanceQuantityAllowanceRolloverPeriodAllowanceRolloverPeriodUnitOfMeasureAllowanceRolloverPeriodUnitOfMeasureNameAllowanceShortDescriptionAllowanceUnitOfMeasureAllowanceUnitOfMeasureNameAllowanceValidityPeriodAllowanceValidityPeriodUnitOfMeasureAllowanceValidityPeriodUnitOfMeasureNameAmountBalanceCategoryCodeBalanceCategoryIdBalanceCategoryNameBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeNameBalanceCodeTypeBalanceProfileIdChargeDefinitionChargeDefinitionCodeChargeDefinitionIdChargePriceTypeCreatedByCreationDateCurrencyCodeEntitlementPlanDetailIdEntitlementPlanDetailNumberEntitlementPlanIdExtendedPrecisionGrantEffectivityPeriodFromGrantEffectivityPeriodToGrantEffectivityTypeLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPERSubscriptionProductFlagPoolAcrossRenewalsFlagPrecisionFactorPrecisionTypeRatePlanIdSubscriptionProductIdSubscriptionProductPuidcommitmentsGET · POST · PATCH · DELETE Subscription Entitlement Plan Commitments · 44 fields · 1 findersAmountBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeNameBalanceCodeTypeBalanceProfileIdChargeDefinitionCodeChargeDefinitionIdChargeDefinitionNameChargePriceTypeCommitmentCommitmentChargeDefinitionIdCommitmentRelatedChargeDefinitionIdCommitmentShortDescriptionCreatedByCreationDateCurrencyCodeEntitlementPlanCommitmentIdEntitlementPlanCommitmentNumberEntitlementPlanIdExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPeriodPeriodNameQuantityRatePlanIdRelatedChargeDefinitionCodeRelatedChargeDefinitionIdRelatedChargeDefinitionNameRelatedChargePeriodRelatedChargePeriodNameRelatedChargePriceTypeRelatedPeriodRelatedPeriodNameRoundedQuantitySubscriptionProductIdSubscriptionProductPuidUnitOfMeasureUnitOfMeasureNameestimatesGET · POST · PATCH · DELETE Subscription Entitlement Plan Estimates · 51 fields · 1 findersAmountBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeNameBalanceCodeTypeBalanceProfileIdChargeDefinitionCodeChargeDefinitionIdChargeDefinitionNameChargePeriodChargePriceTypeCreatedByCreationDateCurrencyCodeEnableRolloverFlagEntitlementPlanEstimateIdEntitlementPlanEstimateNumberEntitlementPlanIdEstimateEstimateChargeDefinitionIdEstimateRelatedChargeDefinitionIdEstimateShortDescriptionExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPeriodPeriodNameQuantityRatePlanIdRelatedChargeDefinitionCodeRelatedChargeDefinitionIdRelatedChargeDefinitionNameRelatedChargePeriodRelatedChargePeriodNameRelatedChargePriceTypeRelatedPeriodRelatedPeriodNameRolloverPeriodRolloverPeriodUnitOfMeasureRolloverPeriodUnitOfMeasureNameRoundedQuantitySubscriptionProductIdSubscriptionProductPuidTrueupOverageFlagTrueupShortageFlagUnitOfMeasureUnitOfMeasureNameunitOfMeasureConversionsGET · POST · PATCH · DELETE Subscription Entitlement Plan UOM Conversions · 33 fields · 1 findersActiveFlagBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeNameBalanceProfileIdBalanceUnitofMeasureClassCodeChargeDefinitionCodeChargeDefinitionIdChargeNameChargePriceTypeChargeUOMCodeChargeUnitOfMeasureConversionCreatedByCreationDateEndDateEntitlementPlanIdEntitlementPlanUOMConversionIdEntitlementPlanUOMConversionNumberLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberProductEntitlementPlanIdRatePlanIdStartDateSubscriptionProductIdSubscriptionProductPuidUOMChargeDefinitionIdUOMCodeUOMConversionRateUnitOfMeasurevolumePricingRulesGET · POST · PATCH · DELETE Subscription Entitlement Pricing Rules · 35 fields · 1 findersAggregationBalanceCodeAggregationBalanceCodeDescriptionAggregationBalanceCodeIdAggregationPeriodAggregationPeriodNameBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeNameBalanceCodeUnitOfMeasureBalanceCodeUnitOfMeasureNameBalanceProfileIdChargeDefinitionChargeDefinitionCodeChargeDefinitionIdChargePriceTypeCreatedByCreationDateEligibilityBalanceCodeIdEntitlementPlanChargeRuleIdEntitlementPlanChargeRuleNumberEntitlementPlanIdLastUpdateDateLastUpdatedByObjectVersionNumberPricingBalanceCodePricingBalanceCodeDescriptionPricingRuleProductEntitlementPlanIdRatePlanIdSubscriptionProductIdSubscriptionProductPuidVolumePricingAggregationFlagVolumePricingChargeDefinitionIdVolumePricingEligibilityFlag
Actions 1
POST …/action/createUsageEntitlement·ratingModelratePlanIdusageEntitlementNumberbalanceProfileIdusageEntitlementId
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/crmRestApi/resources/11.13.18.05/subscriptionUsageEntitlementsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
StandardUsageEntitlementsFinderfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:Action, notaction. - 18 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.