Subscription Balance Codes
subscriptionBalanceCodes Based on latest (2026.09)
Create, change, delete and look up Subscription Balance Codes, with balance code charges, condition criteria and condition criteria predicates. Actions include activate and de activate.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE2 actions
- Record key
BalanceCode- Required on create
BalanceCode- At a glance
- 17 fields3 finders7 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes?fields=BalanceCode,BalanceCodeDescription,BalanceCodeId,BalanceCodeStatus,BalanceCodeType&limit=25&onlyData=true
{
"items": [
{
"BalanceCode": "<string, max 30>",
"BalanceCodeDescription": "<string, max 120>",
"BalanceCodeId": 0,
"BalanceCodeStatus": "ORA_OSS_DRAFT",
"BalanceCodeType": "ORA_OSS_QUANTITY"
}
],
"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 17
| Attribute | Type | Use |
|---|---|---|
BalanceCode | text · max 30 | Required on createUpdatableSearchable |
BalanceCodeDescription | text · max 120 | Optional on createUpdatableSearchable |
BalanceCodeId | number | Optional on createSearchable |
BalanceCodeStatus | text · max 30 · default ORA_OSS_DRAFT | Optional on createUpdatableSearchable |
BalanceCodeType | text · max 30 · default ORA_OSS_QUANTITY | Optional on createSearchable |
BalanceCurrencyCode | text · max 15 | Optional on createSearchable |
BalanceUnitofMeasureCode | text · max 3 | Optional on createSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
MaximumPrecision | number | Optional on createUpdatableSearchable |
ObjectVersionNumber | number | Optional on createUpdatableSearchable |
PrecisionFactor | number | Optional on createUpdatableSearchable |
PrecisionType | text · max 30 | Optional on createUpdatableSearchable |
UnitofMeasureClassCode | text · max 10 | 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 3
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
BalanceCodeAltKey·BalanceCodeBalanceCodeRowFinder·b_balance_code_typeb_charge_definition_idfilterByActiveBalanceCodeRowFinder
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 7
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/subscriptionBalanceCodes/{BalanceCode}/child/<name>. Add them to a GET with expand.
balanceCodeChargesGET · POST · PATCH · DELETE Subscription Balance Code Charges · 13 fields · 1 findersBalanceCodeChargeIdBalanceCodeChargeNumberBalanceCodeIdBalanceUnitofMeasureCodeChargeDefinitionCodeChargeDefinitionIdCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberUnitofMeasureClassCodeconditionCriteriaGET · POST · PATCH · DELETE Subscription Balance Condition Criteria · 12 fields · 1 findersBalanceCriteriaDescriptionBalanceCriteriaIdBalanceCriteriaNumberBalanceCriteriaStatusBalanceCriteriaUsageCreatedByCreationDateCriteriaPrecedenceLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumbersubscriptionBalancePredicatesGET · POST · PATCH · DELETE Subscription Balance Condition Predicates · 23 fields · 1 findersBalanceAttributeIdBalanceAttributeNameBalanceCriteriaIdBalanceCriteriaUsageBalanceObjectIdBalanceObjectNameBalancePredicateCharacterValueBalancePredicateDateValueBalancePredicateDecimalValueBalancePredicateIdBalancePredicateNumberBalancePredicateNumberValueBalancePredicateOperatorBalancePredicateSequenceBalancePredicateSortByBalancePredicateTimeValueCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceTypeconditionCriteriaPredicatesGET · POST · PATCH · DELETE Subscription Balance Condition Predicates · 23 fields · 2 findersBalanceAttributeIdBalanceAttributeNameBalanceAttributeTypeBalanceCriteriaIdBalanceObjectIdBalanceObjectNameBalancePredicateCharacterValueBalancePredicateDateValueBalancePredicateDecimalValueBalancePredicateIdBalancePredicateNumberBalancePredicateNumberValueBalancePredicateOperatorBalancePredicateSequenceBalancePredicateSortByBalancePredicateTimeValueCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceTypeconsumptionCriteriaGET · POST · PATCH · DELETE Subscription Balance Consumption Criteria · 12 fields · 1 findersBalanceCriteriaDescriptionBalanceCriteriaIdBalanceCriteriaNumberBalanceCriteriaStatusBalanceCriteriaUsageCreatedByCreationDateCriteriaPrecedenceLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumbersubscriptionBalancePredicatesGET · POST Subscription Balance Consumption Predicates · 22 fields · 1 findersBalanceAttributeIdBalanceAttributeNameBalanceCriteriaIdBalanceObjectIdBalanceObjectNameBalancePredicateCharacterValueBalancePredicateDateValueBalancePredicateDecimalValueBalancePredicateIdBalancePredicateNumberBalancePredicateNumberValueBalancePredicateOperatorBalancePredicateSequenceBalancePredicateSortByBalancePredicateTimeValueCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceTypeconsumptionCriteriaPredicatesGET · POST · PATCH · DELETE Subscription Balance Consumption Predicates · 23 fields · 2 findersBalanceAttributeIdBalanceAttributeNameBalanceAttributeTypeBalanceCriteriaIdBalanceObjectIdBalanceObjectNameBalancePredicateCharacterValueBalancePredicateDateValueBalancePredicateDecimalValueBalancePredicateIdBalancePredicateNumberBalancePredicateNumberValueBalancePredicateOperatorBalancePredicateSequenceBalancePredicateSortByBalancePredicateTimeValueCreatedByCreationDateLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberSourceType
Actions 2
POST …/{BalanceCode}/action/activatePOST …/{BalanceCode}/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/subscriptionBalanceCodesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
BalanceCodeAltKeyfor 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:BalanceCode, notbalancecode. - 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.