Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. OspGateway
  5. getSubscription
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.OspGateway.getSubscription

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Subscription resource in Oracle Cloud Infrastructure Osp Gateway service.

    Get the subscription plan.

    Example Usage

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

const testSubscription = oci.OspGateway.getSubscription({
    compartmentId: compartmentId,
    ospHomeRegion: subscriptionOspHomeRegion,
    subscriptionId: testSubscriptionOciOspGatewaySubscription.id,
});

    import pulumi
import pulumi_oci as oci

test_subscription = oci.OspGateway.get_subscription(compartment_id=compartment_id,
    osp_home_region=subscription_osp_home_region,
    subscription_id=test_subscription_oci_osp_gateway_subscription["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ospgateway.GetSubscription(ctx, &ospgateway.GetSubscriptionArgs{
			CompartmentId:  compartmentId,
			OspHomeRegion:  subscriptionOspHomeRegion,
			SubscriptionId: testSubscriptionOciOspGatewaySubscription.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSubscription = Oci.OspGateway.GetSubscription.Invoke(new()
    {
        CompartmentId = compartmentId,
        OspHomeRegion = subscriptionOspHomeRegion,
        SubscriptionId = testSubscriptionOciOspGatewaySubscription.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.OspGateway.OspGatewayFunctions;
import com.pulumi.oci.OspGateway.inputs.GetSubscriptionArgs;
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 testSubscription = OspGatewayFunctions.getSubscription(GetSubscriptionArgs.builder()
            .compartmentId(compartmentId)
            .ospHomeRegion(subscriptionOspHomeRegion)
            .subscriptionId(testSubscriptionOciOspGatewaySubscription.id())
            .build());

    }
}

    variables:
  testSubscription:
    fn::invoke:
      function: oci:OspGateway:getSubscription
      arguments:
        compartmentId: ${compartmentId}
        ospHomeRegion: ${subscriptionOspHomeRegion}
        subscriptionId: ${testSubscriptionOciOspGatewaySubscription.id}

    Using getSubscription

    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 getSubscription(args: GetSubscriptionArgs, opts?: InvokeOptions): Promise<GetSubscriptionResult>
function getSubscriptionOutput(args: GetSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionResult>
    def get_subscription(compartment_id: Optional[str] = None,
                     osp_home_region: Optional[str] = None,
                     subscription_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSubscriptionResult
def get_subscription_output(compartment_id: Optional[pulumi.Input[str]] = None,
                     osp_home_region: Optional[pulumi.Input[str]] = None,
                     subscription_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionResult]
    func LookupSubscription(ctx *Context, args *LookupSubscriptionArgs, opts ...InvokeOption) (*LookupSubscriptionResult, error)
func LookupSubscriptionOutput(ctx *Context, args *LookupSubscriptionOutputArgs, opts ...InvokeOption) LookupSubscriptionResultOutput

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

    public static class GetSubscription 
{
    public static Task<GetSubscriptionResult> InvokeAsync(GetSubscriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriptionResult> Invoke(GetSubscriptionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSubscriptionResult> getSubscription(GetSubscriptionArgs args, InvokeOptions options)
public static Output<GetSubscriptionResult> getSubscription(GetSubscriptionArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:OspGateway/getSubscription:getSubscription
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment.
    OspHomeRegion string
    The home region's public name of the logged in user.
    SubscriptionId string
    Subscription id(OCID).
    CompartmentId string
    The OCID of the compartment.
    OspHomeRegion string
    The home region's public name of the logged in user.
    SubscriptionId string
    Subscription id(OCID).
    compartmentId String
    The OCID of the compartment.
    ospHomeRegion String
    The home region's public name of the logged in user.
    subscriptionId String
    Subscription id(OCID).
    compartmentId string
    The OCID of the compartment.
    ospHomeRegion string
    The home region's public name of the logged in user.
    subscriptionId string
    Subscription id(OCID).
    compartment_id str
    The OCID of the compartment.
    osp_home_region str
    The home region's public name of the logged in user.
    subscription_id str
    Subscription id(OCID).
    compartmentId String
    The OCID of the compartment.
    ospHomeRegion String
    The home region's public name of the logged in user.
    subscriptionId String
    Subscription id(OCID).

    getSubscription Result

    The following output properties are available:

    AccountType string
    Account type.
    BillToCustAccountId string
    Bill to customer Account id.
    BillingAddresses List<GetSubscriptionBillingAddress>
    Address details model.
    CompartmentId string
    CurrencyCode string
    Currency code
    Email string
    GsiOrgCode string
    GSI Subscription external code.
    Id string
    Subscription id identifier (OCID).
    IsIntentToPay bool
    Payment intension.
    LanguageCode string
    Language short code (en, de, hu, etc)
    OrganizationId string
    GSI organization external identifier.
    OspHomeRegion string
    PaymentGateways List<GetSubscriptionPaymentGateway>
    Payment gateway details.
    PaymentOptions List<GetSubscriptionPaymentOption>
    Payment option list of a subscription.
    PlanType string
    Subscription plan type.
    ShipToCustAcctRoleId string
    Ship to customer account role.
    ShipToCustAcctSiteId string
    Ship to customer account site address id.
    SubscriptionId string
    SubscriptionPlanNumber string
    Subscription plan number.
    Subscriptions List<GetSubscriptionSubscription>
    TaxInfos List<GetSubscriptionTaxInfo>
    Tax details.
    TimePersonalToCorporateConv string
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    TimePlanUpgrade string
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    TimeStart string
    Start date of the subscription.
    UpgradeState string
    Status of the upgrade.
    UpgradeStateDetails string
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    AccountType string
    Account type.
    BillToCustAccountId string
    Bill to customer Account id.
    BillingAddresses []GetSubscriptionBillingAddress
    Address details model.
    CompartmentId string
    CurrencyCode string
    Currency code
    Email string
    GsiOrgCode string
    GSI Subscription external code.
    Id string
    Subscription id identifier (OCID).
    IsIntentToPay bool
    Payment intension.
    LanguageCode string
    Language short code (en, de, hu, etc)
    OrganizationId string
    GSI organization external identifier.
    OspHomeRegion string
    PaymentGateways []GetSubscriptionPaymentGateway
    Payment gateway details.
    PaymentOptions []GetSubscriptionPaymentOption
    Payment option list of a subscription.
    PlanType string
    Subscription plan type.
    ShipToCustAcctRoleId string
    Ship to customer account role.
    ShipToCustAcctSiteId string
    Ship to customer account site address id.
    SubscriptionId string
    SubscriptionPlanNumber string
    Subscription plan number.
    Subscriptions []GetSubscriptionSubscription
    TaxInfos []GetSubscriptionTaxInfo
    Tax details.
    TimePersonalToCorporateConv string
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    TimePlanUpgrade string
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    TimeStart string
    Start date of the subscription.
    UpgradeState string
    Status of the upgrade.
    UpgradeStateDetails string
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    accountType String
    Account type.
    billToCustAccountId String
    Bill to customer Account id.
    billingAddresses List<GetSubscriptionBillingAddress>
    Address details model.
    compartmentId String
    currencyCode String
    Currency code
    email String
    gsiOrgCode String
    GSI Subscription external code.
    id String
    Subscription id identifier (OCID).
    isIntentToPay Boolean
    Payment intension.
    languageCode String
    Language short code (en, de, hu, etc)
    organizationId String
    GSI organization external identifier.
    ospHomeRegion String
    paymentGateways List<GetSubscriptionPaymentGateway>
    Payment gateway details.
    paymentOptions List<GetSubscriptionPaymentOption>
    Payment option list of a subscription.
    planType String
    Subscription plan type.
    shipToCustAcctRoleId String
    Ship to customer account role.
    shipToCustAcctSiteId String
    Ship to customer account site address id.
    subscriptionId String
    subscriptionPlanNumber String
    Subscription plan number.
    subscriptions List<GetSubscriptionSubscription>
    taxInfos List<GetSubscriptionTaxInfo>
    Tax details.
    timePersonalToCorporateConv String
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    timePlanUpgrade String
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    timeStart String
    Start date of the subscription.
    upgradeState String
    Status of the upgrade.
    upgradeStateDetails String
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    accountType string
    Account type.
    billToCustAccountId string
    Bill to customer Account id.
    billingAddresses GetSubscriptionBillingAddress[]
    Address details model.
    compartmentId string
    currencyCode string
    Currency code
    email string
    gsiOrgCode string
    GSI Subscription external code.
    id string
    Subscription id identifier (OCID).
    isIntentToPay boolean
    Payment intension.
    languageCode string
    Language short code (en, de, hu, etc)
    organizationId string
    GSI organization external identifier.
    ospHomeRegion string
    paymentGateways GetSubscriptionPaymentGateway[]
    Payment gateway details.
    paymentOptions GetSubscriptionPaymentOption[]
    Payment option list of a subscription.
    planType string
    Subscription plan type.
    shipToCustAcctRoleId string
    Ship to customer account role.
    shipToCustAcctSiteId string
    Ship to customer account site address id.
    subscriptionId string
    subscriptionPlanNumber string
    Subscription plan number.
    subscriptions GetSubscriptionSubscription[]
    taxInfos GetSubscriptionTaxInfo[]
    Tax details.
    timePersonalToCorporateConv string
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    timePlanUpgrade string
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    timeStart string
    Start date of the subscription.
    upgradeState string
    Status of the upgrade.
    upgradeStateDetails string
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    account_type str
    Account type.
    bill_to_cust_account_id str
    Bill to customer Account id.
    billing_addresses Sequence[GetSubscriptionBillingAddress]
    Address details model.
    compartment_id str
    currency_code str
    Currency code
    email str
    gsi_org_code str
    GSI Subscription external code.
    id str
    Subscription id identifier (OCID).
    is_intent_to_pay bool
    Payment intension.
    language_code str
    Language short code (en, de, hu, etc)
    organization_id str
    GSI organization external identifier.
    osp_home_region str
    payment_gateways Sequence[GetSubscriptionPaymentGateway]
    Payment gateway details.
    payment_options Sequence[GetSubscriptionPaymentOption]
    Payment option list of a subscription.
    plan_type str
    Subscription plan type.
    ship_to_cust_acct_role_id str
    Ship to customer account role.
    ship_to_cust_acct_site_id str
    Ship to customer account site address id.
    subscription_id str
    subscription_plan_number str
    Subscription plan number.
    subscriptions Sequence[GetSubscriptionSubscription]
    tax_infos Sequence[GetSubscriptionTaxInfo]
    Tax details.
    time_personal_to_corporate_conv str
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    time_plan_upgrade str
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    time_start str
    Start date of the subscription.
    upgrade_state str
    Status of the upgrade.
    upgrade_state_details str
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    accountType String
    Account type.
    billToCustAccountId String
    Bill to customer Account id.
    billingAddresses List<Property Map>
    Address details model.
    compartmentId String
    currencyCode String
    Currency code
    email String
    gsiOrgCode String
    GSI Subscription external code.
    id String
    Subscription id identifier (OCID).
    isIntentToPay Boolean
    Payment intension.
    languageCode String
    Language short code (en, de, hu, etc)
    organizationId String
    GSI organization external identifier.
    ospHomeRegion String
    paymentGateways List<Property Map>
    Payment gateway details.
    paymentOptions List<Property Map>
    Payment option list of a subscription.
    planType String
    Subscription plan type.
    shipToCustAcctRoleId String
    Ship to customer account role.
    shipToCustAcctSiteId String
    Ship to customer account site address id.
    subscriptionId String
    subscriptionPlanNumber String
    Subscription plan number.
    subscriptions List<Property Map>
    taxInfos List<Property Map>
    Tax details.
    timePersonalToCorporateConv String
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    timePlanUpgrade String
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    timeStart String
    Start date of the subscription.
    upgradeState String
    Status of the upgrade.
    upgradeStateDetails String
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)

    Supporting Types

    GetSubscriptionBillingAddress

    AddressKey string
    Address identifier.
    City string
    Name of the city.
    CompanyName string
    Name of the customer company.
    ContributorClass string
    Contributor class of the customer company.
    Country string
    Country of the address.
    County string
    County of the address.
    DepartmentName string
    Department name of the customer company.
    EmailAddress string
    The email address of the paypal user.
    FirstName string
    First name of the paypal user.
    InternalNumber string
    Internal number of the customer company.
    JobTitle string
    Job title of the contact person.
    LastName string
    Last name of the paypal user.
    Line1 string
    Address line 1.
    Line2 string
    Address line 2.
    Line3 string
    Address line 3.
    Line4 string
    Address line 4.
    MiddleName string
    Middle name of the contact person.
    MunicipalInscription string
    Municipal Inscription.
    PhoneCountryCode string
    Phone country code of the contact person.
    PhoneNumber string
    Phone number of the contact person.
    PostalCode string
    Post code of the address.
    Province string
    Province of the address.
    State string
    State of the address.
    StateInscription string
    State Inscription.
    StreetName string
    Street name of the address.
    StreetNumber string
    Street number of the address.
    AddressKey string
    Address identifier.
    City string
    Name of the city.
    CompanyName string
    Name of the customer company.
    ContributorClass string
    Contributor class of the customer company.
    Country string
    Country of the address.
    County string
    County of the address.
    DepartmentName string
    Department name of the customer company.
    EmailAddress string
    The email address of the paypal user.
    FirstName string
    First name of the paypal user.
    InternalNumber string
    Internal number of the customer company.
    JobTitle string
    Job title of the contact person.
    LastName string
    Last name of the paypal user.
    Line1 string
    Address line 1.
    Line2 string
    Address line 2.
    Line3 string
    Address line 3.
    Line4 string
    Address line 4.
    MiddleName string
    Middle name of the contact person.
    MunicipalInscription string
    Municipal Inscription.
    PhoneCountryCode string
    Phone country code of the contact person.
    PhoneNumber string
    Phone number of the contact person.
    PostalCode string
    Post code of the address.
    Province string
    Province of the address.
    State string
    State of the address.
    StateInscription string
    State Inscription.
    StreetName string
    Street name of the address.
    StreetNumber string
    Street number of the address.
    addressKey String
    Address identifier.
    city String
    Name of the city.
    companyName String
    Name of the customer company.
    contributorClass String
    Contributor class of the customer company.
    country String
    Country of the address.
    county String
    County of the address.
    departmentName String
    Department name of the customer company.
    emailAddress String
    The email address of the paypal user.
    firstName String
    First name of the paypal user.
    internalNumber String
    Internal number of the customer company.
    jobTitle String
    Job title of the contact person.
    lastName String
    Last name of the paypal user.
    line1 String
    Address line 1.
    line2 String
    Address line 2.
    line3 String
    Address line 3.
    line4 String
    Address line 4.
    middleName String
    Middle name of the contact person.
    municipalInscription String
    Municipal Inscription.
    phoneCountryCode String
    Phone country code of the contact person.
    phoneNumber String
    Phone number of the contact person.
    postalCode String
    Post code of the address.
    province String
    Province of the address.
    state String
    State of the address.
    stateInscription String
    State Inscription.
    streetName String
    Street name of the address.
    streetNumber String
    Street number of the address.
    addressKey string
    Address identifier.
    city string
    Name of the city.
    companyName string
    Name of the customer company.
    contributorClass string
    Contributor class of the customer company.
    country string
    Country of the address.
    county string
    County of the address.
    departmentName string
    Department name of the customer company.
    emailAddress string
    The email address of the paypal user.
    firstName string
    First name of the paypal user.
    internalNumber string
    Internal number of the customer company.
    jobTitle string
    Job title of the contact person.
    lastName string
    Last name of the paypal user.
    line1 string
    Address line 1.
    line2 string
    Address line 2.
    line3 string
    Address line 3.
    line4 string
    Address line 4.
    middleName string
    Middle name of the contact person.
    municipalInscription string
    Municipal Inscription.
    phoneCountryCode string
    Phone country code of the contact person.
    phoneNumber string
    Phone number of the contact person.
    postalCode string
    Post code of the address.
    province string
    Province of the address.
    state string
    State of the address.
    stateInscription string
    State Inscription.
    streetName string
    Street name of the address.
    streetNumber string
    Street number of the address.
    address_key str
    Address identifier.
    city str
    Name of the city.
    company_name str
    Name of the customer company.
    contributor_class str
    Contributor class of the customer company.
    country str
    Country of the address.
    county str
    County of the address.
    department_name str
    Department name of the customer company.
    email_address str
    The email address of the paypal user.
    first_name str
    First name of the paypal user.
    internal_number str
    Internal number of the customer company.
    job_title str
    Job title of the contact person.
    last_name str
    Last name of the paypal user.
    line1 str
    Address line 1.
    line2 str
    Address line 2.
    line3 str
    Address line 3.
    line4 str
    Address line 4.
    middle_name str
    Middle name of the contact person.
    municipal_inscription str
    Municipal Inscription.
    phone_country_code str
    Phone country code of the contact person.
    phone_number str
    Phone number of the contact person.
    postal_code str
    Post code of the address.
    province str
    Province of the address.
    state str
    State of the address.
    state_inscription str
    State Inscription.
    street_name str
    Street name of the address.
    street_number str
    Street number of the address.
    addressKey String
    Address identifier.
    city String
    Name of the city.
    companyName String
    Name of the customer company.
    contributorClass String
    Contributor class of the customer company.
    country String
    Country of the address.
    county String
    County of the address.
    departmentName String
    Department name of the customer company.
    emailAddress String
    The email address of the paypal user.
    firstName String
    First name of the paypal user.
    internalNumber String
    Internal number of the customer company.
    jobTitle String
    Job title of the contact person.
    lastName String
    Last name of the paypal user.
    line1 String
    Address line 1.
    line2 String
    Address line 2.
    line3 String
    Address line 3.
    line4 String
    Address line 4.
    middleName String
    Middle name of the contact person.
    municipalInscription String
    Municipal Inscription.
    phoneCountryCode String
    Phone country code of the contact person.
    phoneNumber String
    Phone number of the contact person.
    postalCode String
    Post code of the address.
    province String
    Province of the address.
    state String
    State of the address.
    stateInscription String
    State Inscription.
    streetName String
    Street name of the address.
    streetNumber String
    Street number of the address.

    GetSubscriptionPaymentGateway

    GetSubscriptionPaymentGatewayMerchantDefinedData

    CloudAccountName string
    Cloud account name.
    PromoType string
    Promotion type code.
    CloudAccountName string
    Cloud account name.
    PromoType string
    Promotion type code.
    cloudAccountName String
    Cloud account name.
    promoType String
    Promotion type code.
    cloudAccountName string
    Cloud account name.
    promoType string
    Promotion type code.
    cloud_account_name str
    Cloud account name.
    promo_type str
    Promotion type code.
    cloudAccountName String
    Cloud account name.
    promoType String
    Promotion type code.

    GetSubscriptionPaymentOption

    CreditCardType string
    Credit card type.
    EmailAddress string
    The email address of the paypal user.
    ExtBillingAgreementId string
    Agreement id for the paypal account.
    FirstName string
    First name of the paypal user.
    LastDigits string
    Last four digits of the card.
    LastName string
    Last name of the paypal user.
    NameOnCard string
    Name on the credit card.
    PaymentMethod string
    Payment method
    TimeExpiration string
    Expired date of the credit card.
    WalletInstrumentId string
    Wallet instrument internal id.
    WalletTransactionId string
    Wallet transaction id.
    CreditCardType string
    Credit card type.
    EmailAddress string
    The email address of the paypal user.
    ExtBillingAgreementId string
    Agreement id for the paypal account.
    FirstName string
    First name of the paypal user.
    LastDigits string
    Last four digits of the card.
    LastName string
    Last name of the paypal user.
    NameOnCard string
    Name on the credit card.
    PaymentMethod string
    Payment method
    TimeExpiration string
    Expired date of the credit card.
    WalletInstrumentId string
    Wallet instrument internal id.
    WalletTransactionId string
    Wallet transaction id.
    creditCardType String
    Credit card type.
    emailAddress String
    The email address of the paypal user.
    extBillingAgreementId String
    Agreement id for the paypal account.
    firstName String
    First name of the paypal user.
    lastDigits String
    Last four digits of the card.
    lastName String
    Last name of the paypal user.
    nameOnCard String
    Name on the credit card.
    paymentMethod String
    Payment method
    timeExpiration String
    Expired date of the credit card.
    walletInstrumentId String
    Wallet instrument internal id.
    walletTransactionId String
    Wallet transaction id.
    creditCardType string
    Credit card type.
    emailAddress string
    The email address of the paypal user.
    extBillingAgreementId string
    Agreement id for the paypal account.
    firstName string
    First name of the paypal user.
    lastDigits string
    Last four digits of the card.
    lastName string
    Last name of the paypal user.
    nameOnCard string
    Name on the credit card.
    paymentMethod string
    Payment method
    timeExpiration string
    Expired date of the credit card.
    walletInstrumentId string
    Wallet instrument internal id.
    walletTransactionId string
    Wallet transaction id.
    credit_card_type str
    Credit card type.
    email_address str
    The email address of the paypal user.
    ext_billing_agreement_id str
    Agreement id for the paypal account.
    first_name str
    First name of the paypal user.
    last_digits str
    Last four digits of the card.
    last_name str
    Last name of the paypal user.
    name_on_card str
    Name on the credit card.
    payment_method str
    Payment method
    time_expiration str
    Expired date of the credit card.
    wallet_instrument_id str
    Wallet instrument internal id.
    wallet_transaction_id str
    Wallet transaction id.
    creditCardType String
    Credit card type.
    emailAddress String
    The email address of the paypal user.
    extBillingAgreementId String
    Agreement id for the paypal account.
    firstName String
    First name of the paypal user.
    lastDigits String
    Last four digits of the card.
    lastName String
    Last name of the paypal user.
    nameOnCard String
    Name on the credit card.
    paymentMethod String
    Payment method
    timeExpiration String
    Expired date of the credit card.
    walletInstrumentId String
    Wallet instrument internal id.
    walletTransactionId String
    Wallet transaction id.

    GetSubscriptionSubscription

    AccountType string
    Account type.
    BillToCustAccountId string
    Bill to customer Account id.
    BillingAddresses List<GetSubscriptionSubscriptionBillingAddress>
    Address details model.
    CurrencyCode string
    Currency code
    GsiOrgCode string
    GSI Subscription external code.
    Id string
    Subscription id identifier (OCID).
    IsIntentToPay bool
    Payment intension.
    LanguageCode string
    Language short code (en, de, hu, etc)
    OrganizationId string
    GSI organization external identifier.
    PaymentGateways List<GetSubscriptionSubscriptionPaymentGateway>
    Payment gateway details.
    PaymentOptions List<GetSubscriptionSubscriptionPaymentOption>
    Payment option list of a subscription.
    PlanType string
    Subscription plan type.
    ShipToCustAcctRoleId string
    Ship to customer account role.
    ShipToCustAcctSiteId string
    Ship to customer account site address id.
    SubscriptionPlanNumber string
    Subscription plan number.
    TaxInfos List<GetSubscriptionSubscriptionTaxInfo>
    Tax details.
    TimePersonalToCorporateConv string
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    TimePlanUpgrade string
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    TimeStart string
    Start date of the subscription.
    UpgradeState string
    Status of the upgrade.
    UpgradeStateDetails string
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    AccountType string
    Account type.
    BillToCustAccountId string
    Bill to customer Account id.
    BillingAddresses []GetSubscriptionSubscriptionBillingAddress
    Address details model.
    CurrencyCode string
    Currency code
    GsiOrgCode string
    GSI Subscription external code.
    Id string
    Subscription id identifier (OCID).
    IsIntentToPay bool
    Payment intension.
    LanguageCode string
    Language short code (en, de, hu, etc)
    OrganizationId string
    GSI organization external identifier.
    PaymentGateways []GetSubscriptionSubscriptionPaymentGateway
    Payment gateway details.
    PaymentOptions []GetSubscriptionSubscriptionPaymentOption
    Payment option list of a subscription.
    PlanType string
    Subscription plan type.
    ShipToCustAcctRoleId string
    Ship to customer account role.
    ShipToCustAcctSiteId string
    Ship to customer account site address id.
    SubscriptionPlanNumber string
    Subscription plan number.
    TaxInfos []GetSubscriptionSubscriptionTaxInfo
    Tax details.
    TimePersonalToCorporateConv string
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    TimePlanUpgrade string
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    TimeStart string
    Start date of the subscription.
    UpgradeState string
    Status of the upgrade.
    UpgradeStateDetails string
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    accountType String
    Account type.
    billToCustAccountId String
    Bill to customer Account id.
    billingAddresses List<GetSubscriptionSubscriptionBillingAddress>
    Address details model.
    currencyCode String
    Currency code
    gsiOrgCode String
    GSI Subscription external code.
    id String
    Subscription id identifier (OCID).
    isIntentToPay Boolean
    Payment intension.
    languageCode String
    Language short code (en, de, hu, etc)
    organizationId String
    GSI organization external identifier.
    paymentGateways List<GetSubscriptionSubscriptionPaymentGateway>
    Payment gateway details.
    paymentOptions List<GetSubscriptionSubscriptionPaymentOption>
    Payment option list of a subscription.
    planType String
    Subscription plan type.
    shipToCustAcctRoleId String
    Ship to customer account role.
    shipToCustAcctSiteId String
    Ship to customer account site address id.
    subscriptionPlanNumber String
    Subscription plan number.
    taxInfos List<GetSubscriptionSubscriptionTaxInfo>
    Tax details.
    timePersonalToCorporateConv String
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    timePlanUpgrade String
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    timeStart String
    Start date of the subscription.
    upgradeState String
    Status of the upgrade.
    upgradeStateDetails String
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    accountType string
    Account type.
    billToCustAccountId string
    Bill to customer Account id.
    billingAddresses GetSubscriptionSubscriptionBillingAddress[]
    Address details model.
    currencyCode string
    Currency code
    gsiOrgCode string
    GSI Subscription external code.
    id string
    Subscription id identifier (OCID).
    isIntentToPay boolean
    Payment intension.
    languageCode string
    Language short code (en, de, hu, etc)
    organizationId string
    GSI organization external identifier.
    paymentGateways GetSubscriptionSubscriptionPaymentGateway[]
    Payment gateway details.
    paymentOptions GetSubscriptionSubscriptionPaymentOption[]
    Payment option list of a subscription.
    planType string
    Subscription plan type.
    shipToCustAcctRoleId string
    Ship to customer account role.
    shipToCustAcctSiteId string
    Ship to customer account site address id.
    subscriptionPlanNumber string
    Subscription plan number.
    taxInfos GetSubscriptionSubscriptionTaxInfo[]
    Tax details.
    timePersonalToCorporateConv string
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    timePlanUpgrade string
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    timeStart string
    Start date of the subscription.
    upgradeState string
    Status of the upgrade.
    upgradeStateDetails string
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    account_type str
    Account type.
    bill_to_cust_account_id str
    Bill to customer Account id.
    billing_addresses Sequence[GetSubscriptionSubscriptionBillingAddress]
    Address details model.
    currency_code str
    Currency code
    gsi_org_code str
    GSI Subscription external code.
    id str
    Subscription id identifier (OCID).
    is_intent_to_pay bool
    Payment intension.
    language_code str
    Language short code (en, de, hu, etc)
    organization_id str
    GSI organization external identifier.
    payment_gateways Sequence[GetSubscriptionSubscriptionPaymentGateway]
    Payment gateway details.
    payment_options Sequence[GetSubscriptionSubscriptionPaymentOption]
    Payment option list of a subscription.
    plan_type str
    Subscription plan type.
    ship_to_cust_acct_role_id str
    Ship to customer account role.
    ship_to_cust_acct_site_id str
    Ship to customer account site address id.
    subscription_plan_number str
    Subscription plan number.
    tax_infos Sequence[GetSubscriptionSubscriptionTaxInfo]
    Tax details.
    time_personal_to_corporate_conv str
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    time_plan_upgrade str
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    time_start str
    Start date of the subscription.
    upgrade_state str
    Status of the upgrade.
    upgrade_state_details str
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
    accountType String
    Account type.
    billToCustAccountId String
    Bill to customer Account id.
    billingAddresses List<Property Map>
    Address details model.
    currencyCode String
    Currency code
    gsiOrgCode String
    GSI Subscription external code.
    id String
    Subscription id identifier (OCID).
    isIntentToPay Boolean
    Payment intension.
    languageCode String
    Language short code (en, de, hu, etc)
    organizationId String
    GSI organization external identifier.
    paymentGateways List<Property Map>
    Payment gateway details.
    paymentOptions List<Property Map>
    Payment option list of a subscription.
    planType String
    Subscription plan type.
    shipToCustAcctRoleId String
    Ship to customer account role.
    shipToCustAcctSiteId String
    Ship to customer account site address id.
    subscriptionPlanNumber String
    Subscription plan number.
    taxInfos List<Property Map>
    Tax details.
    timePersonalToCorporateConv String
    Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
    timePlanUpgrade String
    Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
    timeStart String
    Start date of the subscription.
    upgradeState String
    Status of the upgrade.
    upgradeStateDetails String
    This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)

    GetSubscriptionSubscriptionBillingAddress

    AddressKey string
    Address identifier.
    City string
    Name of the city.
    CompanyName string
    Name of the customer company.
    ContributorClass string
    Contributor class of the customer company.
    Country string
    Country of the address.
    County string
    County of the address.
    DepartmentName string
    Department name of the customer company.
    EmailAddress string
    The email address of the paypal user.
    FirstName string
    First name of the paypal user.
    InternalNumber string
    Internal number of the customer company.
    JobTitle string
    Job title of the contact person.
    LastName string
    Last name of the paypal user.
    Line1 string
    Address line 1.
    Line2 string
    Address line 2.
    Line3 string
    Address line 3.
    Line4 string
    Address line 4.
    MiddleName string
    Middle name of the contact person.
    MunicipalInscription string
    Municipal Inscription.
    PhoneCountryCode string
    Phone country code of the contact person.
    PhoneNumber string
    Phone number of the contact person.
    PostalCode string
    Post code of the address.
    Province string
    Province of the address.
    State string
    State of the address.
    StateInscription string
    State Inscription.
    StreetName string
    Street name of the address.
    StreetNumber string
    Street number of the address.
    AddressKey string
    Address identifier.
    City string
    Name of the city.
    CompanyName string
    Name of the customer company.
    ContributorClass string
    Contributor class of the customer company.
    Country string
    Country of the address.
    County string
    County of the address.
    DepartmentName string
    Department name of the customer company.
    EmailAddress string
    The email address of the paypal user.
    FirstName string
    First name of the paypal user.
    InternalNumber string
    Internal number of the customer company.
    JobTitle string
    Job title of the contact person.
    LastName string
    Last name of the paypal user.
    Line1 string
    Address line 1.
    Line2 string
    Address line 2.
    Line3 string
    Address line 3.
    Line4 string
    Address line 4.
    MiddleName string
    Middle name of the contact person.
    MunicipalInscription string
    Municipal Inscription.
    PhoneCountryCode string
    Phone country code of the contact person.
    PhoneNumber string
    Phone number of the contact person.
    PostalCode string
    Post code of the address.
    Province string
    Province of the address.
    State string
    State of the address.
    StateInscription string
    State Inscription.
    StreetName string
    Street name of the address.
    StreetNumber string
    Street number of the address.
    addressKey String
    Address identifier.
    city String
    Name of the city.
    companyName String
    Name of the customer company.
    contributorClass String
    Contributor class of the customer company.
    country String
    Country of the address.
    county String
    County of the address.
    departmentName String
    Department name of the customer company.
    emailAddress String
    The email address of the paypal user.
    firstName String
    First name of the paypal user.
    internalNumber String
    Internal number of the customer company.
    jobTitle String
    Job title of the contact person.
    lastName String
    Last name of the paypal user.
    line1 String
    Address line 1.
    line2 String
    Address line 2.
    line3 String
    Address line 3.
    line4 String
    Address line 4.
    middleName String
    Middle name of the contact person.
    municipalInscription String
    Municipal Inscription.
    phoneCountryCode String
    Phone country code of the contact person.
    phoneNumber String
    Phone number of the contact person.
    postalCode String
    Post code of the address.
    province String
    Province of the address.
    state String
    State of the address.
    stateInscription String
    State Inscription.
    streetName String
    Street name of the address.
    streetNumber String
    Street number of the address.
    addressKey string
    Address identifier.
    city string
    Name of the city.
    companyName string
    Name of the customer company.
    contributorClass string
    Contributor class of the customer company.
    country string
    Country of the address.
    county string
    County of the address.
    departmentName string
    Department name of the customer company.
    emailAddress string
    The email address of the paypal user.
    firstName string
    First name of the paypal user.
    internalNumber string
    Internal number of the customer company.
    jobTitle string
    Job title of the contact person.
    lastName string
    Last name of the paypal user.
    line1 string
    Address line 1.
    line2 string
    Address line 2.
    line3 string
    Address line 3.
    line4 string
    Address line 4.
    middleName string
    Middle name of the contact person.
    municipalInscription string
    Municipal Inscription.
    phoneCountryCode string
    Phone country code of the contact person.
    phoneNumber string
    Phone number of the contact person.
    postalCode string
    Post code of the address.
    province string
    Province of the address.
    state string
    State of the address.
    stateInscription string
    State Inscription.
    streetName string
    Street name of the address.
    streetNumber string
    Street number of the address.
    address_key str
    Address identifier.
    city str
    Name of the city.
    company_name str
    Name of the customer company.
    contributor_class str
    Contributor class of the customer company.
    country str
    Country of the address.
    county str
    County of the address.
    department_name str
    Department name of the customer company.
    email_address str
    The email address of the paypal user.
    first_name str
    First name of the paypal user.
    internal_number str
    Internal number of the customer company.
    job_title str
    Job title of the contact person.
    last_name str
    Last name of the paypal user.
    line1 str
    Address line 1.
    line2 str
    Address line 2.
    line3 str
    Address line 3.
    line4 str
    Address line 4.
    middle_name str
    Middle name of the contact person.
    municipal_inscription str
    Municipal Inscription.
    phone_country_code str
    Phone country code of the contact person.
    phone_number str
    Phone number of the contact person.
    postal_code str
    Post code of the address.
    province str
    Province of the address.
    state str
    State of the address.
    state_inscription str
    State Inscription.
    street_name str
    Street name of the address.
    street_number str
    Street number of the address.
    addressKey String
    Address identifier.
    city String
    Name of the city.
    companyName String
    Name of the customer company.
    contributorClass String
    Contributor class of the customer company.
    country String
    Country of the address.
    county String
    County of the address.
    departmentName String
    Department name of the customer company.
    emailAddress String
    The email address of the paypal user.
    firstName String
    First name of the paypal user.
    internalNumber String
    Internal number of the customer company.
    jobTitle String
    Job title of the contact person.
    lastName String
    Last name of the paypal user.
    line1 String
    Address line 1.
    line2 String
    Address line 2.
    line3 String
    Address line 3.
    line4 String
    Address line 4.
    middleName String
    Middle name of the contact person.
    municipalInscription String
    Municipal Inscription.
    phoneCountryCode String
    Phone country code of the contact person.
    phoneNumber String
    Phone number of the contact person.
    postalCode String
    Post code of the address.
    province String
    Province of the address.
    state String
    State of the address.
    stateInscription String
    State Inscription.
    streetName String
    Street name of the address.
    streetNumber String
    Street number of the address.

    GetSubscriptionSubscriptionPaymentGateway

    GetSubscriptionSubscriptionPaymentGatewayMerchantDefinedData

    CloudAccountName string
    Cloud account name.
    PromoType string
    Promotion type code.
    CloudAccountName string
    Cloud account name.
    PromoType string
    Promotion type code.
    cloudAccountName String
    Cloud account name.
    promoType String
    Promotion type code.
    cloudAccountName string
    Cloud account name.
    promoType string
    Promotion type code.
    cloud_account_name str
    Cloud account name.
    promo_type str
    Promotion type code.
    cloudAccountName String
    Cloud account name.
    promoType String
    Promotion type code.

    GetSubscriptionSubscriptionPaymentOption

    CreditCardType string
    Credit card type.
    EmailAddress string
    The email address of the paypal user.
    ExtBillingAgreementId string
    Agreement id for the paypal account.
    FirstName string
    First name of the paypal user.
    LastDigits string
    Last four digits of the card.
    LastName string
    Last name of the paypal user.
    NameOnCard string
    Name on the credit card.
    PaymentMethod string
    Payment method
    TimeExpiration string
    Expired date of the credit card.
    WalletInstrumentId string
    Wallet instrument internal id.
    WalletTransactionId string
    Wallet transaction id.
    CreditCardType string
    Credit card type.
    EmailAddress string
    The email address of the paypal user.
    ExtBillingAgreementId string
    Agreement id for the paypal account.
    FirstName string
    First name of the paypal user.
    LastDigits string
    Last four digits of the card.
    LastName string
    Last name of the paypal user.
    NameOnCard string
    Name on the credit card.
    PaymentMethod string
    Payment method
    TimeExpiration string
    Expired date of the credit card.
    WalletInstrumentId string
    Wallet instrument internal id.
    WalletTransactionId string
    Wallet transaction id.
    creditCardType String
    Credit card type.
    emailAddress String
    The email address of the paypal user.
    extBillingAgreementId String
    Agreement id for the paypal account.
    firstName String
    First name of the paypal user.
    lastDigits String
    Last four digits of the card.
    lastName String
    Last name of the paypal user.
    nameOnCard String
    Name on the credit card.
    paymentMethod String
    Payment method
    timeExpiration String
    Expired date of the credit card.
    walletInstrumentId String
    Wallet instrument internal id.
    walletTransactionId String
    Wallet transaction id.
    creditCardType string
    Credit card type.
    emailAddress string
    The email address of the paypal user.
    extBillingAgreementId string
    Agreement id for the paypal account.
    firstName string
    First name of the paypal user.
    lastDigits string
    Last four digits of the card.
    lastName string
    Last name of the paypal user.
    nameOnCard string
    Name on the credit card.
    paymentMethod string
    Payment method
    timeExpiration string
    Expired date of the credit card.
    walletInstrumentId string
    Wallet instrument internal id.
    walletTransactionId string
    Wallet transaction id.
    credit_card_type str
    Credit card type.
    email_address str
    The email address of the paypal user.
    ext_billing_agreement_id str
    Agreement id for the paypal account.
    first_name str
    First name of the paypal user.
    last_digits str
    Last four digits of the card.
    last_name str
    Last name of the paypal user.
    name_on_card str
    Name on the credit card.
    payment_method str
    Payment method
    time_expiration str
    Expired date of the credit card.
    wallet_instrument_id str
    Wallet instrument internal id.
    wallet_transaction_id str
    Wallet transaction id.
    creditCardType String
    Credit card type.
    emailAddress String
    The email address of the paypal user.
    extBillingAgreementId String
    Agreement id for the paypal account.
    firstName String
    First name of the paypal user.
    lastDigits String
    Last four digits of the card.
    lastName String
    Last name of the paypal user.
    nameOnCard String
    Name on the credit card.
    paymentMethod String
    Payment method
    timeExpiration String
    Expired date of the credit card.
    walletInstrumentId String
    Wallet instrument internal id.
    walletTransactionId String
    Wallet transaction id.

    GetSubscriptionSubscriptionTaxInfo

    NoTaxReasonCode string
    Tax exemption reason code.
    NoTaxReasonCodeDetails string
    Tax exemption reason description.
    TaxCnpj string
    Brazilian companies' CNPJ number.
    TaxPayerId string
    Tay payer identifier.
    TaxRegNumber string
    Tax registration number.
    NoTaxReasonCode string
    Tax exemption reason code.
    NoTaxReasonCodeDetails string
    Tax exemption reason description.
    TaxCnpj string
    Brazilian companies' CNPJ number.
    TaxPayerId string
    Tay payer identifier.
    TaxRegNumber string
    Tax registration number.
    noTaxReasonCode String
    Tax exemption reason code.
    noTaxReasonCodeDetails String
    Tax exemption reason description.
    taxCnpj String
    Brazilian companies' CNPJ number.
    taxPayerId String
    Tay payer identifier.
    taxRegNumber String
    Tax registration number.
    noTaxReasonCode string
    Tax exemption reason code.
    noTaxReasonCodeDetails string
    Tax exemption reason description.
    taxCnpj string
    Brazilian companies' CNPJ number.
    taxPayerId string
    Tay payer identifier.
    taxRegNumber string
    Tax registration number.
    no_tax_reason_code str
    Tax exemption reason code.
    no_tax_reason_code_details str
    Tax exemption reason description.
    tax_cnpj str
    Brazilian companies' CNPJ number.
    tax_payer_id str
    Tay payer identifier.
    tax_reg_number str
    Tax registration number.
    noTaxReasonCode String
    Tax exemption reason code.
    noTaxReasonCodeDetails String
    Tax exemption reason description.
    taxCnpj String
    Brazilian companies' CNPJ number.
    taxPayerId String
    Tay payer identifier.
    taxRegNumber String
    Tax registration number.

    GetSubscriptionTaxInfo

    Giro string
    Companies' GIRO code
    NoTaxReasonCode string
    Tax exemption reason code.
    NoTaxReasonCodeDetails string
    Tax exemption reason description.
    TaxCnpj string
    Brazilian companies' CNPJ number.
    TaxPayerId string
    Tay payer identifier.
    TaxRegNumber string
    Tax registration number.
    Giro string
    Companies' GIRO code
    NoTaxReasonCode string
    Tax exemption reason code.
    NoTaxReasonCodeDetails string
    Tax exemption reason description.
    TaxCnpj string
    Brazilian companies' CNPJ number.
    TaxPayerId string
    Tay payer identifier.
    TaxRegNumber string
    Tax registration number.
    giro String
    Companies' GIRO code
    noTaxReasonCode String
    Tax exemption reason code.
    noTaxReasonCodeDetails String
    Tax exemption reason description.
    taxCnpj String
    Brazilian companies' CNPJ number.
    taxPayerId String
    Tay payer identifier.
    taxRegNumber String
    Tax registration number.
    giro string
    Companies' GIRO code
    noTaxReasonCode string
    Tax exemption reason code.
    noTaxReasonCodeDetails string
    Tax exemption reason description.
    taxCnpj string
    Brazilian companies' CNPJ number.
    taxPayerId string
    Tay payer identifier.
    taxRegNumber string
    Tax registration number.
    giro str
    Companies' GIRO code
    no_tax_reason_code str
    Tax exemption reason code.
    no_tax_reason_code_details str
    Tax exemption reason description.
    tax_cnpj str
    Brazilian companies' CNPJ number.
    tax_payer_id str
    Tay payer identifier.
    tax_reg_number str
    Tax registration number.
    giro String
    Companies' GIRO code
    noTaxReasonCode String
    Tax exemption reason code.
    noTaxReasonCodeDetails String
    Tax exemption reason description.
    taxCnpj String
    Brazilian companies' CNPJ number.
    taxPayerId String
    Tay payer identifier.
    taxRegNumber String
    Tax registration number.

    Package Details

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