Subscription Usage Events
subscriptionUsageEvents Based on latest (2026.09)
Create, change, delete and look up Subscription Usage Events, with usage charges and usage messages. Actions include reverse.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
EventNumber- Required on create
EventNumberEventStartTime- At a glance
- 46 fields1 finders2 children
Try it
Only attributes Oracle marks as searchable are offered.
GET /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents?fields=BatchNumber,CorpCurrencyCode,CreatedBy,CreationDate,CurcyConvRateType&limit=25&onlyData=true
{
"items": [
{
"BatchNumber": "<string, max 120>",
"CorpCurrencyCode": "<string, max 15>",
"CreatedBy": "<string, max 64>",
"CreationDate": "2026-01-31T09:00:00+00:00",
"CurcyConvRateType": "<string, max 30>"
}
],
"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 46
| Attribute | Type | Use |
|---|---|---|
BatchNumber | text · max 120 | Optional on createSearchable |
CorpCurrencyCode | text · max 15 | Optional on createUpdatable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CurcyConvRateType | text · max 30 | Optional on createUpdatable |
CurrencyCode | text · max 15 | Optional on createUpdatable |
Error | text · max 255 | Optional on createUpdatableSearchable |
EventEndTime | date-time | Optional on createUpdatable |
EventId | number | Optional on createSearchable |
EventNumber | text · max 120 | Required on createSearchable |
EventRatingType | text · max 30 | Optional on createUpdatableSearchable |
EventStartTime | date-time | Required on createUpdatableSearchable |
EventStatus | text · max 30 | Optional on createUpdatableSearchable |
EventTimeZone | text · max 50 | Optional on createUpdatable |
EventType | text · max 30 | Optional on createUpdatableSearchable |
EventTypeId | number | Optional on createUpdatable |
FileName | text · max 300 | Optional on createSearchable |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdateLogin | text · max 32 | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LeEventStartDate | date | Read-only |
PricedOn | date-time | Optional on createUpdatable |
RatingSource | text · max 30 | Optional on create |
RelatedBatchId | number | Optional on createUpdatable |
RelatedBatchNumber | text · max 120 | Read-only |
RelatedEventId | number | Optional on createUpdatable |
RelatedEventNumber | text · max 120 | Read-only |
ReportedUsageQuantity | number | Optional on createUpdatable |
ReportedUsageUnitOfMeasure | text · max 3 | Optional on createUpdatableSearchable |
RequestId | number | Read-onlySearchable |
ReversalEligibleFlag | yes/no · max 1 | Read-onlySearchable |
ReverseBatchId | number | Optional on createSearchable |
ReverseBatchNumber | text · max 120 | Optional on createSearchable |
ReverseEventNumber | text · max 120 | Optional on createSearchable |
ReverseFlag | yes/no · max 1 | Read-only |
ServiceId | text · max 120 | Optional on createUpdatableSearchable |
SourceInterfaceType | text · max 30 · default ORA_OSS_SOURCE_API | Optional on createUpdatable |
SubscriptionCurrencyCode | text · max 15 | Read-onlySearchable |
SubscriptionProductPuid | text · max 120 | Optional on createUpdatableSearchable |
SummarizedRatingFlag | yes/no · max 1 | Read-only |
SystemGeneratedFlag | yes/no · max 1 | Read-onlySearchable |
UsageBatchId | number | Optional on createSearchable |
UsageQuantity | number | Optional on createUpdatable |
UsageType | text · max 30 · default ORA_OSS_EVENT_RATING | Read-onlySearchable |
UsageUnitOfMeasure | text · max 3 | Optional on createUpdatable |
VolumeRatingFlag | yes/no · max 1 | Read-only |
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 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
EventNumber·EventNumber
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 2
Child resources sit under one record: /crmRestApi/resources/11.13.18.05/subscriptionUsageEvents/{EventNumber}/child/<name>. Add them to a GET with expand.
usageChargesGET · POST · PATCH · DELETE Subscription Usage Event Charges · 30 fields · 3 findersAllowanceAmountAllowanceQuantityBilledAmountChargeCurrencyChargeDefinitionChargeDefinitionIdChargeNameConversionRateCreatedByCreationDateEventIdExtendedAmountLastUpdateDateLastUpdateLoginLastUpdatedByObjectVersionNumberParentEntityParentEntityIdPricedQuantityPricedQuantityUnitOfMeasureRoundedQuantitySequenceNumberSubscriptionIdSubscriptionProductIdUnitPriceUsageChargeIdUsageChargePuidUsageQuantityUserReportedQuantityUserReportedUnitOfMeasureusageMessagesGET Subscription Usage Event Messages · 18 fields · 1 findersAdditionalMessageTextBatchIdBatchNumberCreatedByCreationDateEventNumberLastUpdateDateLastUpdateLoginLastUpdatedByMessageNameMessageTextMessageTypeMessageUserDetailsObjectVersionNumberParentEntityParentEntityIdTranslatedMessageTextUsageMessageId
Actions 1
POST …/{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/subscriptionUsageEventsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
EventNumberfor 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:BatchNumber, notbatchnumber. - 16 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.