Subscription Entitlement Plans
subscriptionEntitlementPlans Based on latest (2026.09)
Create, change, delete and look up Subscription Entitlement Plans, with UOM conversions, commitments and estimates. Actions include activate and de activate.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE2 actions
- Record key
EntitlementPlanNumber- Required on create
BalanceProfileIdEntitlementPlanNameEntitlementPlanNumber- At a glance
- 25 fields3 finders5 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans?fields=AllowanceGrantFlag,BalanceProfileId,BalanceProfileName,BalanceProfileNumber,CommitmentFlag&limit=25&onlyData=true
{
"items": [
{
"AllowanceGrantFlag": false,
"BalanceProfileId": 0,
"BalanceProfileName": "<string, max 120>",
"BalanceProfileNumber": "<string, max 120>",
"CommitmentFlag": false
}
],
"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 25
| Attribute | Type | Use |
|---|---|---|
AllowanceGrantFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
BalanceProfileId | number | Required on createUpdatableSearchable |
BalanceProfileName | text · max 120 | Optional on createUpdatableSearchable |
BalanceProfileNumber | text · max 120 | Optional on createUpdatableSearchable |
CommitmentFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EntitlementPlanDescription | text · max 300 | Optional on createUpdatableSearchable |
EntitlementPlanId | number | Optional on createSearchable |
EntitlementPlanName | text · max 120 | Required on createUpdatableSearchable |
EntitlementPlanNumber | text · max 120 | Required on createSearchable |
EntitlementPlanStatus | text · max 30 · default ORA_OSS_DRAFT | Optional on createUpdatableSearchable |
EstimateFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
EventType | text · max 30 | Optional on createUpdatableSearchable |
EventTypeId | number | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ObjectVersionNumber | number | Optional on createUpdatableSearchable |
RatePlanId | number | Optional on createSearchable |
RatePlanNumber | text · max 120 | Optional on createSearchable |
RatingModel | text · max 30 | Optional on createSearchable |
SummarizedRatingFlag | yes/no · max 1 · default false | Optional on createSearchable |
UOMConversionsEnabledFlag | yes/no · max 255 | Read-only |
VolumeRatingFlag | yes/no · max 1 | Optional 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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
ActiveEntitlementRowFinderActiveSubscritionEntitlementPlansFinderEntitlementPlanAltKey·EntitlementPlanNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 5
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/<name>. Add them to a GET with expand.
UOMConversionsGET · POST · PATCH · DELETE Subscription Entitlement Plan UOM Conversions · 33 fields · 1 findersActiveFlagBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeNameBalanceProfileIdBalanceUnitofMeasureClassCodeChargeDefinitionCodeChargeDefinitionIdChargeNameChargePriceTypeChargeUOMCodeChargeUnitOfMeasureConversionCreatedByCreationDateEndDateEntitlementPlanIdEntitlementPlanUOMConversionIdEntitlementPlanUOMConversionNumberLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberProductEntitlementPlanIdRatePlanIdStartDateSubscriptionProductIdSubscriptionProductPuidUOMChargeDefinitionIdUOMCodeUOMConversionRateUnitOfMeasurecommitmentsGET · POST · PATCH · DELETE Subscription Entitlement Plan Commitments · 44 fields · 1 findersAmountBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeNameBalanceCodeTypeBalanceProfileIdChargeDefinitionCodeChargeDefinitionIdChargeDefinitionNameChargePriceTypeCommitmentCommitmentChargeDefinitionIdCommitmentRelatedChargeDefinitionIdCommitmentShortDescriptionCreatedByCreationDateCurrencyCodeEntitlementPlanCommitmentIdEntitlementPlanCommitmentNumberEntitlementPlanIdExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPeriodPeriodNameQuantityRatePlanIdRelatedChargeDefinitionCodeRelatedChargeDefinitionIdRelatedChargeDefinitionNameRelatedChargePeriodRelatedChargePeriodNameRelatedChargePriceTypeRelatedPeriodRelatedPeriodNameRoundedQuantitySubscriptionProductIdSubscriptionProductPuidUnitOfMeasureUnitOfMeasureNameestimatesGET · POST · PATCH · DELETE Subscription Entitlement Plan Estimates · 51 fields · 1 findersAmountBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeNameBalanceCodeTypeBalanceProfileIdChargeDefinitionCodeChargeDefinitionIdChargeDefinitionNameChargePeriodChargePriceTypeCreatedByCreationDateCurrencyCodeEnableRolloverFlagEntitlementPlanEstimateIdEntitlementPlanEstimateNumberEntitlementPlanIdEstimateEstimateChargeDefinitionIdEstimateRelatedChargeDefinitionIdEstimateShortDescriptionExtendedPrecisionLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPeriodPeriodNameQuantityRatePlanIdRelatedChargeDefinitionCodeRelatedChargeDefinitionIdRelatedChargeDefinitionNameRelatedChargePeriodRelatedChargePeriodNameRelatedChargePriceTypeRelatedPeriodRelatedPeriodNameRolloverPeriodRolloverPeriodUnitOfMeasureRolloverPeriodUnitOfMeasureNameRoundedQuantitySubscriptionProductIdSubscriptionProductPuidTrueupOverageFlagTrueupShortageFlagUnitOfMeasureUnitOfMeasureNamesubscriptionEntitlementPlanDetailsGET · POST · PATCH · DELETE Subscription Entitlement Plan Details · 52 fields · 1 findersAdditionalPoolingFilterAllowanceAllowanceChargeDefinitionIdAllowancePeriodicityAllowancePeriodicityNameAllowancePoolingGroupAllowanceQuantityAllowanceRolloverPeriodAllowanceRolloverPeriodUnitOfMeasureAllowanceRolloverPeriodUnitOfMeasureNameAllowanceShortDescriptionAllowanceUnitOfMeasureAllowanceUnitOfMeasureNameAllowanceValidityPeriodAllowanceValidityPeriodUnitOfMeasureAllowanceValidityPeriodUnitOfMeasureNameAmountBalanceCategoryCodeBalanceCategoryIdBalanceCategoryNameBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeMaxPrecisionBalanceCodeNameBalanceCodeTypeBalanceProfileIdChargeDefinitionChargeDefinitionCodeChargeDefinitionIdChargePriceTypeCreatedByCreationDateCurrencyCodeEntitlementPlanDetailIdEntitlementPlanDetailNumberEntitlementPlanIdExtendedPrecisionGrantEffectivityPeriodFromGrantEffectivityPeriodToGrantEffectivityTypeLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPERSubscriptionProductFlagPoolAcrossRenewalsFlagPrecisionFactorPrecisionTypeRatePlanIdSubscriptionProductIdSubscriptionProductPuidvolumePricingRulesGET · POST · PATCH · DELETE Subscription Entitlement Pricing Rules · 35 fields · 1 findersAggregationBalanceCodeAggregationBalanceCodeDescriptionAggregationBalanceCodeIdAggregationPeriodAggregationPeriodNameBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeNameBalanceCodeUnitOfMeasureBalanceCodeUnitOfMeasureNameBalanceProfileIdChargeDefinitionChargeDefinitionCodeChargeDefinitionIdChargePriceTypeCreatedByCreationDateEligibilityBalanceCodeIdEntitlementPlanChargeRuleIdEntitlementPlanChargeRuleNumberEntitlementPlanIdLastUpdateDateLastUpdatedByObjectVersionNumberPricingBalanceCodePricingBalanceCodeDescriptionPricingRuleProductEntitlementPlanIdRatePlanIdSubscriptionProductIdSubscriptionProductPuidVolumePricingAggregationFlagVolumePricingChargeDefinitionIdVolumePricingEligibilityFlag
Actions 2
POST …/{EntitlementPlanNumber}/action/activatePOST …/{EntitlementPlanNumber}/action/deActivate
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/subscriptionEntitlementPlansand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
ActiveEntitlementRowFinderfor 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:AllowanceGrantFlag, notallowancegrantflag. - 6 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.