Subscription Balance Profiles
subscriptionBalanceProfiles Based on latest (2026.09)
Create, change, delete and look up Subscription Balance Profiles, with group criteria, group criteria balance predicates and profile balance codes. Actions include activate and de activate.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE2 actions
- Record key
BalanceProfileNumber- Required on create
BalanceProfileNameBalanceProfileNumber- At a glance
- 43 fields2 finders6 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/subscriptionBalanceProfiles?fields=AllowanceEffectivityType,AmendNewPartialPeriodOption,AmendTerminatedPartialPeriodOption,ApplyChargeAdjustmentRatingFlag,BalanceProfileId&limit=25&onlyData=true
{
"items": [
{
"AllowanceEffectivityType": "ORA_OSS_BAL_REGISTER_PERIOD",
"AmendNewPartialPeriodOption": "<string, max 30>",
"AmendTerminatedPartialPeriodOption": "<string, max 30>",
"ApplyChargeAdjustmentRatingFlag": true,
"BalanceProfileId": 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 43
| Attribute | Type | Use |
|---|---|---|
AllowanceEffectivityType | text · max 30 · default ORA_OSS_BAL_REGISTER_PERIOD | Optional on createUpdatableSearchable |
AmendNewPartialPeriodOption | text · max 30 | Optional on createUpdatableSearchable |
AmendTerminatedPartialPeriodOption | text · max 30 | Optional on createUpdatableSearchable |
ApplyChargeAdjustmentRatingFlag | yes/no · max 1 · default true | Optional on createUpdatableSearchable |
BalanceProfileId | number | Optional on createSearchable |
BalanceProfileName | text · max 120 | Required on createUpdatableSearchable |
BalanceProfileNumber | text · max 120 | Required on createSearchable |
BalanceProfileStatus | text · max 30 · default ORA_OSS_DRAFT | Optional on createUpdatableSearchable |
BillOnDay | number | Optional on createUpdatableSearchable |
BillPeriodAlignDate | date | Optional on createUpdatableSearchable |
BillingDate | text · max 80 | Optional on createUpdatableSearchable |
BillingDateCode | text · max 30 | Optional on createUpdatableSearchable |
BillingFrequency | text · max 30 | Optional on createUpdatableSearchable |
BillingFrequencyUnitOfMeasure | text · max 25 | Optional on createUpdatableSearchable |
BillingOffsetDays | number | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
EstimateDateCode | text · max 30 | Optional on createUpdatableSearchable |
EstimateOffsetDays | number | Optional on createUpdatableSearchable |
EventType | text · max 30 | Optional on createUpdatableSearchable |
EventTypeId | number | Optional on createUpdatableSearchable |
FirstPartialPeriodOption | text · max 30 | Optional on createUpdatableSearchable |
FixedDaysInMonth | number · default 31 | Optional on createUpdatableSearchable |
InterfaceOffsetDays | number | Optional on createUpdatableSearchable |
InvoicingRuleId | number | Optional on createUpdatableSearchable |
InvoicingRuleName | text · max 30 | Optional on createUpdatableSearchable |
InvoicingRuleNameForRest | text · max 30 | Optional on createUpdatableSearchable |
LastPartialPeriodOption | text · max 30 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
ManualTrueupFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
ObjectVersionNumber | number | Optional on createUpdatableSearchable |
PartialPeriodMonthType | text · max 30 · default ORA_FIXED | Optional on createUpdatableSearchable |
PeriodAlignDateType | text · max 30 · default ORA_OSS_BAL_REG_AND_BILL_LINES | Optional on createUpdatableSearchable |
RatePlanFlag | yes/no · max 1 | Optional on createSearchable |
RegisterUpdateFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
SummarizedOffsetDays | number | Optional on createUpdatableSearchable |
SummarizedRatingDateCode | text · max 30 | Optional on createUpdatableSearchable |
TerminatedPartialPeriodOption | text · max 30 | Optional on createUpdatableSearchable |
TrueupOffsetCode | text · max 30 | Optional on createUpdatableSearchable |
TrueupOffsetDays | number | Optional on createUpdatableSearchable |
TrueupOverrideFlag | yes/no · max 1 · default false | Optional on createUpdatableSearchable |
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.
BalProfileAltKey·BalanceProfileNumberBalanceProfilesFinder
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/subscriptionBalanceProfiles/{BalanceProfileNumber}/child/<name>. Add them to a GET with expand.
groupCriteriaGET · POST · PATCH · DELETE Subscription Balance Condition Criteria · 12 fields · 1 findersBalanceCriteriaDescriptionBalanceCriteriaIdBalanceCriteriaNumberBalanceCriteriaStatusBalanceCriteriaUsageCreatedByCreationDateCriteriaPrecedenceLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumbersubscriptionBalancePredicatesGET · POST · PATCH · DELETE Subscription Balance Condition Predicates · 23 fields · 1 findersBalanceAttributeIdBalanceAttributeNameBalanceCriteriaIdBalanceCriteriaUsageBalanceObjectIdBalanceObjectNameBalancePredicateCharacterValueBalancePredicateDateValueBalancePredicateDecimalValueBalancePredicateIdBalancePredicateNumberBalancePredicateNumberValueBalancePredicateOperatorBalancePredicateSequenceBalancePredicateSortByBalancePredicateTimeValueCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceTypegroupCriteriaBalancePredicatesGET · POST · PATCH · DELETE Subscription Balance Condition Predicates · 23 fields · 2 findersBalanceAttributeIdBalanceAttributeNameBalanceAttributeTypeBalanceCriteriaIdBalanceObjectIdBalanceObjectNameBalancePredicateCharacterValueBalancePredicateDateValueBalancePredicateDecimalValueBalancePredicateIdBalancePredicateNumberBalancePredicateNumberValueBalancePredicateOperatorBalancePredicateSequenceBalancePredicateSortByBalancePredicateTimeValueCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceTypeprofileBalanceCodesGET · POST · PATCH · DELETE Subscription Profile Balance Codes · 20 fields · 6 findersAllowanceGrantCodeFlagBalanceCodeBalanceCodeDescriptionBalanceCodeIdBalanceCodeIdForRestBalancePrecedenceBalanceProfileChargeIdBalanceProfileIdBalanceUnitofMeasureClassCodeCommitmentCodeFlagCreatedByCreationDateEstimateCodeFlagLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberProfileBalanceCodeIdProfileBalanceCodeNumberVolumePricingFlagprofileCategoriesGET · POST · PATCH · DELETE Subscription Balance Profile Categories · 10 fields · 2 findersBalanceProfileCategoryIdBalanceProfileCategoryNumberBalanceProfileIdCategoryCodeCategoryPrecedenceCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByprofileChargesGET · POST · PATCH · DELETE Subscription Balance Profile Charges · 28 fields · 1 findersAllowanceGrantFlagBalanceProfileChargeIdBalanceProfileChargeNumberBalanceProfileIdBillingFrequencyBillingFrequencyUnitOfMeasureChargeDefinitionCodeChargeDefinitionIdChargePeriodChargePeriodUnitOfMeasureChargeTypeCommitmentFlagCreatedByCreationDateEstimateFlagInvoicingRuleInvoicingRuleForRestInvoicingRuleIdLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberPriceTypeCodeRelatedChargeDefinitionCodeRelatedChargeDefinitionIdRelatedProfileChargeIdUsageCaptureFlagVolumePricingFlag
Actions 2
POST …/{BalanceProfileNumber}/action/activatePOST …/{BalanceProfileNumber}/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/subscriptionBalanceProfilesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
BalProfileAltKeyfor 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:AllowanceEffectivityType, notallowanceeffectivitytype. - 5 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.