1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. OsubSubscription
  5. getRatecards
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.OsubSubscription.getRatecards

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides the list of Ratecards in Oracle Cloud Infrastructure Osub Subscription service.

List API that returns all ratecards for given Subscription Id and Account ID (if provided) and for a particular date range

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testRatecards = oci.OsubSubscription.getRatecards({
    compartmentId: compartmentId,
    subscriptionId: testSubscription.id,
    partNumber: ratecardPartNumber,
    timeFrom: ratecardTimeFrom,
    timeTo: ratecardTimeTo,
    xOneOriginRegion: ratecardXOneOriginRegion,
});
Copy
import pulumi
import pulumi_oci as oci

test_ratecards = oci.OsubSubscription.get_ratecards(compartment_id=compartment_id,
    subscription_id=test_subscription["id"],
    part_number=ratecard_part_number,
    time_from=ratecard_time_from,
    time_to=ratecard_time_to,
    x_one_origin_region=ratecard_x_one_origin_region)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/osubsubscription"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := osubsubscription.GetRatecards(ctx, &osubsubscription.GetRatecardsArgs{
			CompartmentId:    compartmentId,
			SubscriptionId:   testSubscription.Id,
			PartNumber:       pulumi.StringRef(ratecardPartNumber),
			TimeFrom:         pulumi.StringRef(ratecardTimeFrom),
			TimeTo:           pulumi.StringRef(ratecardTimeTo),
			XOneOriginRegion: pulumi.StringRef(ratecardXOneOriginRegion),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testRatecards = Oci.OsubSubscription.GetRatecards.Invoke(new()
    {
        CompartmentId = compartmentId,
        SubscriptionId = testSubscription.Id,
        PartNumber = ratecardPartNumber,
        TimeFrom = ratecardTimeFrom,
        TimeTo = ratecardTimeTo,
        XOneOriginRegion = ratecardXOneOriginRegion,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.OsubSubscription.OsubSubscriptionFunctions;
import com.pulumi.oci.OsubSubscription.inputs.GetRatecardsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testRatecards = OsubSubscriptionFunctions.getRatecards(GetRatecardsArgs.builder()
            .compartmentId(compartmentId)
            .subscriptionId(testSubscription.id())
            .partNumber(ratecardPartNumber)
            .timeFrom(ratecardTimeFrom)
            .timeTo(ratecardTimeTo)
            .xOneOriginRegion(ratecardXOneOriginRegion)
            .build());

    }
}
Copy
variables:
  testRatecards:
    fn::invoke:
      function: oci:OsubSubscription:getRatecards
      arguments:
        compartmentId: ${compartmentId}
        subscriptionId: ${testSubscription.id}
        partNumber: ${ratecardPartNumber}
        timeFrom: ${ratecardTimeFrom}
        timeTo: ${ratecardTimeTo}
        xOneOriginRegion: ${ratecardXOneOriginRegion}
Copy

Using getRatecards

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRatecards(args: GetRatecardsArgs, opts?: InvokeOptions): Promise<GetRatecardsResult>
function getRatecardsOutput(args: GetRatecardsOutputArgs, opts?: InvokeOptions): Output<GetRatecardsResult>
Copy
def get_ratecards(compartment_id: Optional[str] = None,
                  filters: Optional[Sequence[_osubsubscription.GetRatecardsFilter]] = None,
                  part_number: Optional[str] = None,
                  subscription_id: Optional[str] = None,
                  time_from: Optional[str] = None,
                  time_to: Optional[str] = None,
                  x_one_origin_region: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRatecardsResult
def get_ratecards_output(compartment_id: Optional[pulumi.Input[str]] = None,
                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[_osubsubscription.GetRatecardsFilterArgs]]]] = None,
                  part_number: Optional[pulumi.Input[str]] = None,
                  subscription_id: Optional[pulumi.Input[str]] = None,
                  time_from: Optional[pulumi.Input[str]] = None,
                  time_to: Optional[pulumi.Input[str]] = None,
                  x_one_origin_region: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetRatecardsResult]
Copy
func GetRatecards(ctx *Context, args *GetRatecardsArgs, opts ...InvokeOption) (*GetRatecardsResult, error)
func GetRatecardsOutput(ctx *Context, args *GetRatecardsOutputArgs, opts ...InvokeOption) GetRatecardsResultOutput
Copy

> Note: This function is named GetRatecards in the Go SDK.

public static class GetRatecards 
{
    public static Task<GetRatecardsResult> InvokeAsync(GetRatecardsArgs args, InvokeOptions? opts = null)
    public static Output<GetRatecardsResult> Invoke(GetRatecardsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRatecardsResult> getRatecards(GetRatecardsArgs args, InvokeOptions options)
public static Output<GetRatecardsResult> getRatecards(GetRatecardsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:OsubSubscription/getRatecards:getRatecards
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the compartment.
SubscriptionId This property is required. string
Line level Subscription Id
Filters Changes to this property will trigger replacement. List<GetRatecardsFilter>
PartNumber string
This param is used to get the rate card(s) filterd by the partNumber
TimeFrom string
This param is used to get the rate card(s) whose effective start date starts on or after a particular date
TimeTo string
This param is used to get the rate card(s) whose effective end date ends on or before a particular date
XOneOriginRegion string
The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
CompartmentId This property is required. string
The OCID of the compartment.
SubscriptionId This property is required. string
Line level Subscription Id
Filters Changes to this property will trigger replacement. []GetRatecardsFilter
PartNumber string
This param is used to get the rate card(s) filterd by the partNumber
TimeFrom string
This param is used to get the rate card(s) whose effective start date starts on or after a particular date
TimeTo string
This param is used to get the rate card(s) whose effective end date ends on or before a particular date
XOneOriginRegion string
The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
compartmentId This property is required. String
The OCID of the compartment.
subscriptionId This property is required. String
Line level Subscription Id
filters Changes to this property will trigger replacement. List<GetRatecardsFilter>
partNumber String
This param is used to get the rate card(s) filterd by the partNumber
timeFrom String
This param is used to get the rate card(s) whose effective start date starts on or after a particular date
timeTo String
This param is used to get the rate card(s) whose effective end date ends on or before a particular date
xOneOriginRegion String
The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
compartmentId This property is required. string
The OCID of the compartment.
subscriptionId This property is required. string
Line level Subscription Id
filters Changes to this property will trigger replacement. GetRatecardsFilter[]
partNumber string
This param is used to get the rate card(s) filterd by the partNumber
timeFrom string
This param is used to get the rate card(s) whose effective start date starts on or after a particular date
timeTo string
This param is used to get the rate card(s) whose effective end date ends on or before a particular date
xOneOriginRegion string
The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
compartment_id This property is required. str
The OCID of the compartment.
subscription_id This property is required. str
Line level Subscription Id
filters Changes to this property will trigger replacement. Sequence[osubsubscription.GetRatecardsFilter]
part_number str
This param is used to get the rate card(s) filterd by the partNumber
time_from str
This param is used to get the rate card(s) whose effective start date starts on or after a particular date
time_to str
This param is used to get the rate card(s) whose effective end date ends on or before a particular date
x_one_origin_region str
The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
compartmentId This property is required. String
The OCID of the compartment.
subscriptionId This property is required. String
Line level Subscription Id
filters Changes to this property will trigger replacement. List<Property Map>
partNumber String
This param is used to get the rate card(s) filterd by the partNumber
timeFrom String
This param is used to get the rate card(s) whose effective start date starts on or after a particular date
timeTo String
This param is used to get the rate card(s) whose effective end date ends on or before a particular date
xOneOriginRegion String
The Oracle Cloud Infrastructure home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.

getRatecards Result

The following output properties are available:

CompartmentId string
Id string
The provider-assigned unique ID for this managed resource.
RateCards List<GetRatecardsRateCard>
The list of rate_cards.
SubscriptionId string
Filters List<GetRatecardsFilter>
PartNumber string
Product part numner
TimeFrom string
TimeTo string
XOneOriginRegion string
CompartmentId string
Id string
The provider-assigned unique ID for this managed resource.
RateCards []GetRatecardsRateCard
The list of rate_cards.
SubscriptionId string
Filters []GetRatecardsFilter
PartNumber string
Product part numner
TimeFrom string
TimeTo string
XOneOriginRegion string
compartmentId String
id String
The provider-assigned unique ID for this managed resource.
rateCards List<GetRatecardsRateCard>
The list of rate_cards.
subscriptionId String
filters List<GetRatecardsFilter>
partNumber String
Product part numner
timeFrom String
timeTo String
xOneOriginRegion String
compartmentId string
id string
The provider-assigned unique ID for this managed resource.
rateCards GetRatecardsRateCard[]
The list of rate_cards.
subscriptionId string
filters GetRatecardsFilter[]
partNumber string
Product part numner
timeFrom string
timeTo string
xOneOriginRegion string
compartment_id str
id str
The provider-assigned unique ID for this managed resource.
rate_cards Sequence[osubsubscription.GetRatecardsRateCard]
The list of rate_cards.
subscription_id str
filters Sequence[osubsubscription.GetRatecardsFilter]
part_number str
Product part numner
time_from str
time_to str
x_one_origin_region str
compartmentId String
id String
The provider-assigned unique ID for this managed resource.
rateCards List<Property Map>
The list of rate_cards.
subscriptionId String
filters List<Property Map>
partNumber String
Product part numner
timeFrom String
timeTo String
xOneOriginRegion String

Supporting Types

GetRatecardsFilter

Name This property is required. string
Product name
Values This property is required. List<string>
Regex bool
Name This property is required. string
Product name
Values This property is required. []string
Regex bool
name This property is required. String
Product name
values This property is required. List<String>
regex Boolean
name This property is required. string
Product name
values This property is required. string[]
regex boolean
name This property is required. str
Product name
values This property is required. Sequence[str]
regex bool
name This property is required. String
Product name
values This property is required. List<String>
regex Boolean

GetRatecardsRateCard

Currencies This property is required. List<GetRatecardsRateCardCurrency>
Currency details
DiscretionaryDiscountPercentage This property is required. string
Rate card discretionary discount percentage
IsTier This property is required. bool
Rate card price tier flag
NetUnitPrice This property is required. string
Rate card tier net unit price
OveragePrice This property is required. string
Rate card tier overage price
Products This property is required. List<GetRatecardsRateCardProduct>
Product description
RateCardTiers This property is required. List<GetRatecardsRateCardRateCardTier>
List of tiered rate card prices
TimeEnd This property is required. string
Rate card end date
TimeStart This property is required. string
Rate card start date
Currencies This property is required. []GetRatecardsRateCardCurrency
Currency details
DiscretionaryDiscountPercentage This property is required. string
Rate card discretionary discount percentage
IsTier This property is required. bool
Rate card price tier flag
NetUnitPrice This property is required. string
Rate card tier net unit price
OveragePrice This property is required. string
Rate card tier overage price
Products This property is required. []GetRatecardsRateCardProduct
Product description
RateCardTiers This property is required. []GetRatecardsRateCardRateCardTier
List of tiered rate card prices
TimeEnd This property is required. string
Rate card end date
TimeStart This property is required. string
Rate card start date
currencies This property is required. List<GetRatecardsRateCardCurrency>
Currency details
discretionaryDiscountPercentage This property is required. String
Rate card discretionary discount percentage
isTier This property is required. Boolean
Rate card price tier flag
netUnitPrice This property is required. String
Rate card tier net unit price
overagePrice This property is required. String
Rate card tier overage price
products This property is required. List<GetRatecardsRateCardProduct>
Product description
rateCardTiers This property is required. List<GetRatecardsRateCardRateCardTier>
List of tiered rate card prices
timeEnd This property is required. String
Rate card end date
timeStart This property is required. String
Rate card start date
currencies This property is required. GetRatecardsRateCardCurrency[]
Currency details
discretionaryDiscountPercentage This property is required. string
Rate card discretionary discount percentage
isTier This property is required. boolean
Rate card price tier flag
netUnitPrice This property is required. string
Rate card tier net unit price
overagePrice This property is required. string
Rate card tier overage price
products This property is required. GetRatecardsRateCardProduct[]
Product description
rateCardTiers This property is required. GetRatecardsRateCardRateCardTier[]
List of tiered rate card prices
timeEnd This property is required. string
Rate card end date
timeStart This property is required. string
Rate card start date
currencies This property is required. Sequence[osubsubscription.GetRatecardsRateCardCurrency]
Currency details
discretionary_discount_percentage This property is required. str
Rate card discretionary discount percentage
is_tier This property is required. bool
Rate card price tier flag
net_unit_price This property is required. str
Rate card tier net unit price
overage_price This property is required. str
Rate card tier overage price
products This property is required. Sequence[osubsubscription.GetRatecardsRateCardProduct]
Product description
rate_card_tiers This property is required. Sequence[osubsubscription.GetRatecardsRateCardRateCardTier]
List of tiered rate card prices
time_end This property is required. str
Rate card end date
time_start This property is required. str
Rate card start date
currencies This property is required. List<Property Map>
Currency details
discretionaryDiscountPercentage This property is required. String
Rate card discretionary discount percentage
isTier This property is required. Boolean
Rate card price tier flag
netUnitPrice This property is required. String
Rate card tier net unit price
overagePrice This property is required. String
Rate card tier overage price
products This property is required. List<Property Map>
Product description
rateCardTiers This property is required. List<Property Map>
List of tiered rate card prices
timeEnd This property is required. String
Rate card end date
timeStart This property is required. String
Rate card start date

GetRatecardsRateCardCurrency

IsoCode This property is required. string
Currency Code
Name This property is required. string
Product name
StdPrecision This property is required. string
Standard Precision of the Currency
IsoCode This property is required. string
Currency Code
Name This property is required. string
Product name
StdPrecision This property is required. string
Standard Precision of the Currency
isoCode This property is required. String
Currency Code
name This property is required. String
Product name
stdPrecision This property is required. String
Standard Precision of the Currency
isoCode This property is required. string
Currency Code
name This property is required. string
Product name
stdPrecision This property is required. string
Standard Precision of the Currency
iso_code This property is required. str
Currency Code
name This property is required. str
Product name
std_precision This property is required. str
Standard Precision of the Currency
isoCode This property is required. String
Currency Code
name This property is required. String
Product name
stdPrecision This property is required. String
Standard Precision of the Currency

GetRatecardsRateCardProduct

BillingCategory This property is required. string
Metered service billing category
Name This property is required. string
Product name
PartNumber This property is required. string
This param is used to get the rate card(s) filterd by the partNumber
ProductCategory This property is required. string
Product category
UcmRateCardPartType This property is required. string
Rate card part type of Product
UnitOfMeasure This property is required. string
Unit of measure
BillingCategory This property is required. string
Metered service billing category
Name This property is required. string
Product name
PartNumber This property is required. string
This param is used to get the rate card(s) filterd by the partNumber
ProductCategory This property is required. string
Product category
UcmRateCardPartType This property is required. string
Rate card part type of Product
UnitOfMeasure This property is required. string
Unit of measure
billingCategory This property is required. String
Metered service billing category
name This property is required. String
Product name
partNumber This property is required. String
This param is used to get the rate card(s) filterd by the partNumber
productCategory This property is required. String
Product category
ucmRateCardPartType This property is required. String
Rate card part type of Product
unitOfMeasure This property is required. String
Unit of measure
billingCategory This property is required. string
Metered service billing category
name This property is required. string
Product name
partNumber This property is required. string
This param is used to get the rate card(s) filterd by the partNumber
productCategory This property is required. string
Product category
ucmRateCardPartType This property is required. string
Rate card part type of Product
unitOfMeasure This property is required. string
Unit of measure
billing_category This property is required. str
Metered service billing category
name This property is required. str
Product name
part_number This property is required. str
This param is used to get the rate card(s) filterd by the partNumber
product_category This property is required. str
Product category
ucm_rate_card_part_type This property is required. str
Rate card part type of Product
unit_of_measure This property is required. str
Unit of measure
billingCategory This property is required. String
Metered service billing category
name This property is required. String
Product name
partNumber This property is required. String
This param is used to get the rate card(s) filterd by the partNumber
productCategory This property is required. String
Product category
ucmRateCardPartType This property is required. String
Rate card part type of Product
unitOfMeasure This property is required. String
Unit of measure

GetRatecardsRateCardRateCardTier

NetUnitPrice This property is required. string
Rate card tier net unit price
OveragePrice This property is required. string
Rate card tier overage price
UpToQuantity This property is required. string
Rate card tier quantity range
NetUnitPrice This property is required. string
Rate card tier net unit price
OveragePrice This property is required. string
Rate card tier overage price
UpToQuantity This property is required. string
Rate card tier quantity range
netUnitPrice This property is required. String
Rate card tier net unit price
overagePrice This property is required. String
Rate card tier overage price
upToQuantity This property is required. String
Rate card tier quantity range
netUnitPrice This property is required. string
Rate card tier net unit price
overagePrice This property is required. string
Rate card tier overage price
upToQuantity This property is required. string
Rate card tier quantity range
net_unit_price This property is required. str
Rate card tier net unit price
overage_price This property is required. str
Rate card tier overage price
up_to_quantity This property is required. str
Rate card tier quantity range
netUnitPrice This property is required. String
Rate card tier net unit price
overagePrice This property is required. String
Rate card tier overage price
upToQuantity This property is required. String
Rate card tier quantity range

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi