onesubscription.oracle.com/v1beta1¶
APIVersion: onesubscription.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes onesubscription.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Subscription | Namespaced | Sample | - |
Subscription¶
Observe existing OCI OneSubscription subscription summaries.
Plural:subscriptionsScope:NamespacedAPIVersion:onesubscription.oracle.com/v1beta1Sample: Sample (config/samples/onesubscription_v1beta1_subscription.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
SubscriptionSpec defines the desired state of Subscription.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
buyerEmail |
Optional buyer email filter for the observe-only subscription query. Exactly one of planNumber, subscriptionId, or buyerEmail must be set. |
string |
No | - | - |
compartmentId |
The compartment OCID required by ListSubscriptions. Provide exactly one of planNumber, subscriptionId, or buyerEmail with it. |
string |
Yes | - | - |
isCommitInfoRequired |
Whether OCI should include commitment details in the returned subscription summary payload. | boolean |
No | - | - |
planNumber |
Optional plan number filter for the observe-only subscription query. Exactly one of planNumber, subscriptionId, or buyerEmail must be set. |
string |
No | - | - |
subscriptionId |
Optional subscription identifier filter for the observe-only subscription query. This scopes the list request, but it does not prove a gettable top-level OCI Subscription identity. | string |
No | - | - |
Status¶
SubscriptionStatus defines the observed state of Subscription.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
currency |
SubscriptionCurrency defines nested fields for Subscription.Currency. | object |
No | - | - |
holdReason |
Hold reason of the plan | string |
No | - | - |
sdkStatus |
The raw subscription status returned by OneSubscription. | string |
No | - | - |
serviceName |
Customer friendly service name provided by PRG | string |
No | - | - |
status |
- | object |
Yes | - | - |
subscribedServices |
List of Subscribed Services of the plan | list[object] |
No | - | - |
timeEnd |
Represents the date when the last service of the subscription ends | string |
No | - | - |
timeHoldReleaseEta |
Represents the date of the hold release | string |
No | - | - |
timeStart |
Represents the date when the first service of the subscription was activated | string |
No | - | - |
Status.currency¶
SubscriptionCurrency defines nested fields for Subscription.Currency.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
isoCode |
Currency Code | string |
No | - | - |
name |
Currency name | string |
No | - | - |
stdPrecision |
Standard Precision of the Currency | integer (int64) |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Status.subscribedServices[]¶
SubscriptionSubscribedService defines nested fields for Subscription.SubscribedService.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availableAmount |
Subscribed sercice available or remaining amount | string |
No | - | - |
bookingOptyNumber |
Booking Opportunity Number of Subscribed Service | string |
No | - | - |
commitmentServices |
List of Commitment services of a line | list[object] |
No | - | - |
csi |
Subscribed service CSI number | integer (int64) |
No | - | - |
dataCenterRegion |
Subscribed service data center region | string |
No | - | - |
fundedAllocationValue |
Funded Allocation line value example: 12000.00 | string |
No | - | - |
id |
SPM internal Subscribed Service ID | string |
No | - | - |
isIntentToPay |
Subscribed service intent to pay flag | boolean |
No | - | - |
netUnitPrice |
Subscribed service net unit price | string |
No | - | - |
operationType |
Subscribed service operation type | string |
No | - | - |
orderNumber |
Sales Order Number associated to the subscribed service | integer (int64) |
No | - | - |
originalPromoAmount |
Subscribed service Promotion Amount | string |
No | - | - |
partnerTransactionType |
This field contains the name of the partner to which the subscription belongs - depending on which the invoicing may differ | string |
No | - | - |
pricingModel |
Subscribed service pricing model | string |
No | - | - |
product |
SubscriptionSubscribedServiceProduct defines nested fields for Subscription.SubscribedService.Product. | object |
No | - | - |
programType |
Subscribed service program type | string |
No | - | - |
promoType |
Subscribed service promotion type | string |
No | - | - |
quantity |
Subscribed service quantity | string |
No | - | - |
status |
Subscribed service status | string |
No | - | - |
termValue |
Term value in Months | integer (int64) |
No | - | - |
termValueUom |
Term value UOM | string |
No | - | - |
timeEnd |
Subscribed service end date | string |
No | - | - |
timeStart |
Subscribed service start date | string |
No | - | - |
totalValue |
Subscribed service total value | string |
No | - | - |
usedAmount |
Subscribed service used amount | string |
No | - | - |
Status.subscribedServices[].commitmentServices[]¶
SubscriptionSubscribedServiceCommitmentService defines nested fields for Subscription.SubscribedService.CommitmentService.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
availableAmount |
Commitment available amount | string |
No | - | - |
fundedAllocationValue |
Funded Allocation line value | string |
No | - | - |
lineNetAmount |
Commitment line net amount | string |
No | - | - |
quantity |
Commitment quantity | string |
No | - | - |
timeEnd |
Commitment end date | string |
No | - | - |
timeStart |
Commitment start date | string |
No | - | - |
Status.subscribedServices[].product¶
SubscriptionSubscribedServiceProduct defines nested fields for Subscription.SubscribedService.Product.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
name |
Product name | string |
No | - | - |
partNumber |
Product part numner | string |
No | - | - |
provisioningGroup |
Product provisioning group | string |
No | - | - |
unitOfMeasure |
Unit of measure | string |
No | - | - |