Subscription Usage Event Batches
subscriptionUsageEventBatches Based on latest (2026.09)
Create, change, delete and look up Subscription Usage Event Batches, with rule builder conditions, usage business unit batches and usage event batch errors. Actions include get metrics for usage batches and get my batches metrics.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE8 actions
- Record key
BatchNumber- Required on create
BatchNumber- At a glance
- 34 fields2 finders7 children1 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/subscriptionUsageEventBatches?fields=BatchDescription,BatchNumber,BatchStatus,BusinessUnitId,BusinessUnitName&limit=25&onlyData=true
{
"items": [
{
"BatchDescription": "<string, max 2000>",
"BatchNumber": "<string, max 120>",
"BatchStatus": "<string, max 30>",
"BusinessUnitId": 0,
"BusinessUnitName": "<string, max 240>"
}
],
"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 34
| Attribute | Type | Use |
|---|---|---|
BatchDescription | text · max 2000 | Optional on createUpdatableSearchable |
BatchNumber | text · max 120 | Required on createSearchable |
BatchStatus | text · max 30 | Optional on createUpdatableSearchable |
BusinessUnitId | number | Optional on createSearchable |
BusinessUnitName | text · max 240 | Optional on createUpdatableSearchable |
CountOfUsageEvents | number | Optional on createUpdatableSearchable |
CountOfUsageEventsErrored | number | Optional on createUpdatableSearchable |
CountOfUsageEventsInprocess | number | Optional on createUpdatableSearchable |
CountOfUsageEventsProcessed | number | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CreationType | text · max 30 · default ORA_OSS_MANUAL | Optional on createSearchable |
CriteriaJson | text | Optional on createUpdatable |
DistinctErrorsCount | number | Optional on createUpdatableSearchable |
ErrorCount | number | Optional on createUpdatable |
FileName | text · max 255 | Read-onlySearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
OwnerResourceId | number | Optional on create |
PricerType | text · max 30 | Read-onlySearchable |
ProcessId | number | Read-onlySearchable |
ProcessName | text · max 30 | Read-onlySearchable |
ProcessStatus | text · max 30 | Read-onlySearchable |
ProcessedDate | date | Optional on createUpdatableSearchable |
RatingProcScheduleDatetime | date-time | Optional on createUpdatableSearchable |
RequestId | number | Read-onlySearchable |
ScheduleType | text · max 30 · default ORA_OSS_MANUAL | Optional on createSearchable |
SubmitFlag | yes/no | Optional on createUpdatable |
SubmitForReratingFlag | yes/no · default false | Optional on create |
TrueupFlag | yes/no · max 1 | Read-only |
UsageBatchId | number | Optional on createSearchable |
UsageEventsErrors | text · max 255 | Optional on createUpdatableSearchable |
UsageType | text · max 30 · default ORA_OSS_EVENT_RATING | 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.
UsageBatchesFinderUsageBatchesForCreateFinder·bindBusinessUnitId
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/subscriptionUsageEventBatches/{BatchNumber}/child/<name>. Add them to a GET with expand.
ruleBuilderConditionsGET · POST · PATCH · DELETE Rule Builder Conditions · 16 fields · 1 findersConditionGroupNameConditionGroupTypeConditionIdConditionJsonConditionNumberConditionRestQParamCreatedByCreationDateDisplaySequenceLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberQualifiedRestObjectNameReferenceEntityIdReferenceEntityNameusageBusinessUnitBatchesGET Subscription Usage Event Business Unit Batches · 14 fields · 1 findersBatchIdBusinessUnitBatchIdBusinessUnitBatchNumberBusinessUnitIdCreatedByCreationDateErroredEventsCountEventsCountEventsProcessedCountInprocessEventsCountLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberusageEventBatchErrorsGET · POST · PATCH · DELETE Subscription Usage Event Errors · 12 fields · 2 findersBatchIdBatchNumberCountOfErroredEventsCreatedByCreationDateEventBatchErrorIdEventBatchErrorNumberLastUpdateDateLastUpdatedByMessageNameMessageTextMessageUserDetailsusageEventBatchFilesGET Subscription Usage Event Batch Files · 10 fields · 1 findersBatchFileIdBatchFileNumberBatchIdCreatedByCreationDateFileNameLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberusageEventsGET · POST · PATCH · DELETE Subscription Usage Events · 46 fieldsBatchNumberCorpCurrencyCodeCreatedByCreationDateCurcyConvRateTypeCurrencyCodeErrorEventEndTimeEventIdEventNumberEventRatingTypeEventStartTimeEventStatusEventTimeZoneEventTypeEventTypeIdFileNameLastUpdateDateLastUpdateLoginLastUpdatedByLeEventStartDatePricedOnRatingSourceRelatedBatchIdRelatedBatchNumberRelatedEventIdRelatedEventNumberReportedUsageQuantityReportedUsageUnitOfMeasureRequestIdReversalEligibleFlagReverseBatchIdReverseBatchNumberReverseEventNumberReverseFlagServiceIdSourceInterfaceTypeSubscriptionCurrencyCodeSubscriptionProductPuidSummarizedRatingFlagSystemGeneratedFlagUsageBatchIdUsageQuantityUsageTypeUsageUnitOfMeasureVolumeRatingFlagusageChargesGET · POST · PATCH · DELETE Subscription Usage Event Charges · 30 fields · 1 findersAllowanceAmountAllowanceQuantityBilledAmountChargeCurrencyChargeDefinitionChargeDefinitionIdChargeNameConversionRateCreatedByCreationDateEventIdExtendedAmountLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberParentEntityParentEntityIdPricedQuantityPricedQuantityUnitOfMeasureRoundedQuantitySequenceNumberSubscriptionIdSubscriptionProductIdUnitPriceUsageChargeIdUsageChargePuidUsageQuantityUserReportedQuantityUserReportedUnitOfMeasureusageMessagesGET Subscription Usage Event Messages · 18 fieldsAdditionalMessageTextBatchIdBatchNumberCreatedByCreationDateEventNumberLastUpdateDateLastUpdateLoginLastUpdatedByMessageNameMessageTextMessageTypeMessageUserDetailsObjectVersionNumberParentEntityParentEntityIdTranslatedMessageTextUsageMessageId
Actions 8
POST …/action/getMetricsForUsageBatches·timeUnitValuetimeUnitCodebatchStatusPOST …/action/getMyBatchesMetrics·noOfDaysPOST …/{BatchNumber}/action/addEvents·ruleBuilderConditionsPOST …/{BatchNumber}/action/deleteEvents·moderuleBuilderConditionsPOST …/{BatchNumber}/action/lockForReviewPOST …/{BatchNumber}/action/revertForEditPOST …/{BatchNumber}/action/submitPOST …/{BatchNumber}/child/usageEvents/{EventNumber}/action/reverse·reverseBatchNumberreverseBatchIdreverseEventNumber
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/subscriptionUsageEventBatchesand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
UsageBatchesFinderfor 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:BatchDescription, notbatchdescription. - 12 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.