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

oci.OspGateway.Subscription

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Subscription resource in Oracle Cloud Infrastructure Osp Gateway service.

Update plan of the subscription.

Create Subscription Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Subscription(name: string, args: SubscriptionArgs, opts?: CustomResourceOptions);
@overload
def Subscription(resource_name: str,
                 args: SubscriptionArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Subscription(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 email: Optional[str] = None,
                 osp_home_region: Optional[str] = None,
                 subscription: Optional[_ospgateway.SubscriptionSubscriptionArgs] = None,
                 subscription_id: Optional[str] = None)
func NewSubscription(ctx *Context, name string, args SubscriptionArgs, opts ...ResourceOption) (*Subscription, error)
public Subscription(string name, SubscriptionArgs args, CustomResourceOptions? opts = null)
public Subscription(String name, SubscriptionArgs args)
public Subscription(String name, SubscriptionArgs args, CustomResourceOptions options)

type: oci:OspGateway:Subscription
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SubscriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var ociSubscriptionResource = new Oci.OspGateway.Subscription("ociSubscriptionResource", new()
{
    CompartmentId = "string",
    Email = "string",
    OspHomeRegion = "string",
    SubscriptionDetails = new Oci.OspGateway.Inputs.SubscriptionSubscriptionArgs
    {
        SubscriptionPlanNumber = "string",
        PaymentOptions = new[]
        {
            new Oci.OspGateway.Inputs.SubscriptionSubscriptionPaymentOptionArgs
            {
                PaymentMethod = "string",
                CreditCardType = "string",
                EmailAddress = "string",
                ExtBillingAgreementId = "string",
                FirstName = "string",
                LastDigits = "string",
                LastName = "string",
                NameOnCard = "string",
                TimeExpiration = "string",
                WalletInstrumentId = "string",
                WalletTransactionId = "string",
            },
        },
        BillingAddresses = new[]
        {
            new Oci.OspGateway.Inputs.SubscriptionSubscriptionBillingAddressArgs
            {
                AddressKey = "string",
                City = "string",
                CompanyName = "string",
                ContributorClass = "string",
                Country = "string",
                County = "string",
                DepartmentName = "string",
                EmailAddress = "string",
                FirstName = "string",
                InternalNumber = "string",
                JobTitle = "string",
                LastName = "string",
                Line1 = "string",
                Line2 = "string",
                Line3 = "string",
                Line4 = "string",
                MiddleName = "string",
                MunicipalInscription = "string",
                PhoneCountryCode = "string",
                PhoneNumber = "string",
                PostalCode = "string",
                Province = "string",
                State = "string",
                StateInscription = "string",
                StreetName = "string",
                StreetNumber = "string",
            },
        },
        CurrencyCode = "string",
        GsiOrgCode = "string",
        Id = "string",
        IsIntentToPay = false,
        LanguageCode = "string",
        OrganizationId = "string",
        AccountType = "string",
        PaymentGateway = new Oci.OspGateway.Inputs.SubscriptionSubscriptionPaymentGatewayArgs
        {
            MerchantDefinedData = new Oci.OspGateway.Inputs.SubscriptionSubscriptionPaymentGatewayMerchantDefinedDataArgs
            {
                CloudAccountName = "string",
                PromoType = "string",
            },
        },
        ShipToCustAcctSiteId = "string",
        ShipToCustAcctRoleId = "string",
        PlanType = "string",
        BillToCustAccountId = "string",
        TaxInfo = new Oci.OspGateway.Inputs.SubscriptionSubscriptionTaxInfoArgs
        {
            NoTaxReasonCode = "string",
            NoTaxReasonCodeDetails = "string",
            TaxCnpj = "string",
            TaxPayerId = "string",
            TaxRegNumber = "string",
        },
        TimePersonalToCorporateConv = "string",
        TimePlanUpgrade = "string",
        TimeStart = "string",
        UpgradeState = "string",
        UpgradeStateDetails = "string",
    },
    SubscriptionId = "string",
});
Copy
example, err := OspGateway.NewSubscription(ctx, "ociSubscriptionResource", &OspGateway.SubscriptionArgs{
	CompartmentId: pulumi.String("string"),
	Email:         pulumi.String("string"),
	OspHomeRegion: pulumi.String("string"),
	Subscription: &ospgateway.SubscriptionSubscriptionArgs{
		SubscriptionPlanNumber: pulumi.String("string"),
		PaymentOptions: ospgateway.SubscriptionSubscriptionPaymentOptionArray{
			&ospgateway.SubscriptionSubscriptionPaymentOptionArgs{
				PaymentMethod:         pulumi.String("string"),
				CreditCardType:        pulumi.String("string"),
				EmailAddress:          pulumi.String("string"),
				ExtBillingAgreementId: pulumi.String("string"),
				FirstName:             pulumi.String("string"),
				LastDigits:            pulumi.String("string"),
				LastName:              pulumi.String("string"),
				NameOnCard:            pulumi.String("string"),
				TimeExpiration:        pulumi.String("string"),
				WalletInstrumentId:    pulumi.String("string"),
				WalletTransactionId:   pulumi.String("string"),
			},
		},
		BillingAddresses: ospgateway.SubscriptionSubscriptionBillingAddressArray{
			&ospgateway.SubscriptionSubscriptionBillingAddressArgs{
				AddressKey:           pulumi.String("string"),
				City:                 pulumi.String("string"),
				CompanyName:          pulumi.String("string"),
				ContributorClass:     pulumi.String("string"),
				Country:              pulumi.String("string"),
				County:               pulumi.String("string"),
				DepartmentName:       pulumi.String("string"),
				EmailAddress:         pulumi.String("string"),
				FirstName:            pulumi.String("string"),
				InternalNumber:       pulumi.String("string"),
				JobTitle:             pulumi.String("string"),
				LastName:             pulumi.String("string"),
				Line1:                pulumi.String("string"),
				Line2:                pulumi.String("string"),
				Line3:                pulumi.String("string"),
				Line4:                pulumi.String("string"),
				MiddleName:           pulumi.String("string"),
				MunicipalInscription: pulumi.String("string"),
				PhoneCountryCode:     pulumi.String("string"),
				PhoneNumber:          pulumi.String("string"),
				PostalCode:           pulumi.String("string"),
				Province:             pulumi.String("string"),
				State:                pulumi.String("string"),
				StateInscription:     pulumi.String("string"),
				StreetName:           pulumi.String("string"),
				StreetNumber:         pulumi.String("string"),
			},
		},
		CurrencyCode:   pulumi.String("string"),
		GsiOrgCode:     pulumi.String("string"),
		Id:             pulumi.String("string"),
		IsIntentToPay:  pulumi.Bool(false),
		LanguageCode:   pulumi.String("string"),
		OrganizationId: pulumi.String("string"),
		AccountType:    pulumi.String("string"),
		PaymentGateway: &ospgateway.SubscriptionSubscriptionPaymentGatewayArgs{
			MerchantDefinedData: &ospgateway.SubscriptionSubscriptionPaymentGatewayMerchantDefinedDataArgs{
				CloudAccountName: pulumi.String("string"),
				PromoType:        pulumi.String("string"),
			},
		},
		ShipToCustAcctSiteId: pulumi.String("string"),
		ShipToCustAcctRoleId: pulumi.String("string"),
		PlanType:             pulumi.String("string"),
		BillToCustAccountId:  pulumi.String("string"),
		TaxInfo: &ospgateway.SubscriptionSubscriptionTaxInfoArgs{
			NoTaxReasonCode:        pulumi.String("string"),
			NoTaxReasonCodeDetails: pulumi.String("string"),
			TaxCnpj:                pulumi.String("string"),
			TaxPayerId:             pulumi.String("string"),
			TaxRegNumber:           pulumi.String("string"),
		},
		TimePersonalToCorporateConv: pulumi.String("string"),
		TimePlanUpgrade:             pulumi.String("string"),
		TimeStart:                   pulumi.String("string"),
		UpgradeState:                pulumi.String("string"),
		UpgradeStateDetails:         pulumi.String("string"),
	},
	SubscriptionId: pulumi.String("string"),
})
Copy
var ociSubscriptionResource = new Subscription("ociSubscriptionResource", SubscriptionArgs.builder()
    .compartmentId("string")
    .email("string")
    .ospHomeRegion("string")
    .subscription(SubscriptionSubscriptionArgs.builder()
        .subscriptionPlanNumber("string")
        .paymentOptions(SubscriptionSubscriptionPaymentOptionArgs.builder()
            .paymentMethod("string")
            .creditCardType("string")
            .emailAddress("string")
            .extBillingAgreementId("string")
            .firstName("string")
            .lastDigits("string")
            .lastName("string")
            .nameOnCard("string")
            .timeExpiration("string")
            .walletInstrumentId("string")
            .walletTransactionId("string")
            .build())
        .billingAddresses(SubscriptionSubscriptionBillingAddressArgs.builder()
            .addressKey("string")
            .city("string")
            .companyName("string")
            .contributorClass("string")
            .country("string")
            .county("string")
            .departmentName("string")
            .emailAddress("string")
            .firstName("string")
            .internalNumber("string")
            .jobTitle("string")
            .lastName("string")
            .line1("string")
            .line2("string")
            .line3("string")
            .line4("string")
            .middleName("string")
            .municipalInscription("string")
            .phoneCountryCode("string")
            .phoneNumber("string")
            .postalCode("string")
            .province("string")
            .state("string")
            .stateInscription("string")
            .streetName("string")
            .streetNumber("string")
            .build())
        .currencyCode("string")
        .gsiOrgCode("string")
        .id("string")
        .isIntentToPay(false)
        .languageCode("string")
        .organizationId("string")
        .accountType("string")
        .paymentGateway(SubscriptionSubscriptionPaymentGatewayArgs.builder()
            .merchantDefinedData(SubscriptionSubscriptionPaymentGatewayMerchantDefinedDataArgs.builder()
                .cloudAccountName("string")
                .promoType("string")
                .build())
            .build())
        .shipToCustAcctSiteId("string")
        .shipToCustAcctRoleId("string")
        .planType("string")
        .billToCustAccountId("string")
        .taxInfo(SubscriptionSubscriptionTaxInfoArgs.builder()
            .noTaxReasonCode("string")
            .noTaxReasonCodeDetails("string")
            .taxCnpj("string")
            .taxPayerId("string")
            .taxRegNumber("string")
            .build())
        .timePersonalToCorporateConv("string")
        .timePlanUpgrade("string")
        .timeStart("string")
        .upgradeState("string")
        .upgradeStateDetails("string")
        .build())
    .subscriptionId("string")
    .build());
Copy
oci_subscription_resource = oci.osp_gateway.Subscription("ociSubscriptionResource",
    compartment_id="string",
    email="string",
    osp_home_region="string",
    subscription={
        "subscription_plan_number": "string",
        "payment_options": [{
            "payment_method": "string",
            "credit_card_type": "string",
            "email_address": "string",
            "ext_billing_agreement_id": "string",
            "first_name": "string",
            "last_digits": "string",
            "last_name": "string",
            "name_on_card": "string",
            "time_expiration": "string",
            "wallet_instrument_id": "string",
            "wallet_transaction_id": "string",
        }],
        "billing_addresses": [{
            "address_key": "string",
            "city": "string",
            "company_name": "string",
            "contributor_class": "string",
            "country": "string",
            "county": "string",
            "department_name": "string",
            "email_address": "string",
            "first_name": "string",
            "internal_number": "string",
            "job_title": "string",
            "last_name": "string",
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "line4": "string",
            "middle_name": "string",
            "municipal_inscription": "string",
            "phone_country_code": "string",
            "phone_number": "string",
            "postal_code": "string",
            "province": "string",
            "state": "string",
            "state_inscription": "string",
            "street_name": "string",
            "street_number": "string",
        }],
        "currency_code": "string",
        "gsi_org_code": "string",
        "id": "string",
        "is_intent_to_pay": False,
        "language_code": "string",
        "organization_id": "string",
        "account_type": "string",
        "payment_gateway": {
            "merchant_defined_data": {
                "cloud_account_name": "string",
                "promo_type": "string",
            },
        },
        "ship_to_cust_acct_site_id": "string",
        "ship_to_cust_acct_role_id": "string",
        "plan_type": "string",
        "bill_to_cust_account_id": "string",
        "tax_info": {
            "no_tax_reason_code": "string",
            "no_tax_reason_code_details": "string",
            "tax_cnpj": "string",
            "tax_payer_id": "string",
            "tax_reg_number": "string",
        },
        "time_personal_to_corporate_conv": "string",
        "time_plan_upgrade": "string",
        "time_start": "string",
        "upgrade_state": "string",
        "upgrade_state_details": "string",
    },
    subscription_id="string")
Copy
const ociSubscriptionResource = new oci.ospgateway.Subscription("ociSubscriptionResource", {
    compartmentId: "string",
    email: "string",
    ospHomeRegion: "string",
    subscription: {
        subscriptionPlanNumber: "string",
        paymentOptions: [{
            paymentMethod: "string",
            creditCardType: "string",
            emailAddress: "string",
            extBillingAgreementId: "string",
            firstName: "string",
            lastDigits: "string",
            lastName: "string",
            nameOnCard: "string",
            timeExpiration: "string",
            walletInstrumentId: "string",
            walletTransactionId: "string",
        }],
        billingAddresses: [{
            addressKey: "string",
            city: "string",
            companyName: "string",
            contributorClass: "string",
            country: "string",
            county: "string",
            departmentName: "string",
            emailAddress: "string",
            firstName: "string",
            internalNumber: "string",
            jobTitle: "string",
            lastName: "string",
            line1: "string",
            line2: "string",
            line3: "string",
            line4: "string",
            middleName: "string",
            municipalInscription: "string",
            phoneCountryCode: "string",
            phoneNumber: "string",
            postalCode: "string",
            province: "string",
            state: "string",
            stateInscription: "string",
            streetName: "string",
            streetNumber: "string",
        }],
        currencyCode: "string",
        gsiOrgCode: "string",
        id: "string",
        isIntentToPay: false,
        languageCode: "string",
        organizationId: "string",
        accountType: "string",
        paymentGateway: {
            merchantDefinedData: {
                cloudAccountName: "string",
                promoType: "string",
            },
        },
        shipToCustAcctSiteId: "string",
        shipToCustAcctRoleId: "string",
        planType: "string",
        billToCustAccountId: "string",
        taxInfo: {
            noTaxReasonCode: "string",
            noTaxReasonCodeDetails: "string",
            taxCnpj: "string",
            taxPayerId: "string",
            taxRegNumber: "string",
        },
        timePersonalToCorporateConv: "string",
        timePlanUpgrade: "string",
        timeStart: "string",
        upgradeState: "string",
        upgradeStateDetails: "string",
    },
    subscriptionId: "string",
});
Copy
type: oci:OspGateway:Subscription
properties:
    compartmentId: string
    email: string
    ospHomeRegion: string
    subscription:
        accountType: string
        billToCustAccountId: string
        billingAddresses:
            - addressKey: string
              city: string
              companyName: string
              contributorClass: string
              country: string
              county: string
              departmentName: string
              emailAddress: string
              firstName: string
              internalNumber: string
              jobTitle: string
              lastName: string
              line1: string
              line2: string
              line3: string
              line4: string
              middleName: string
              municipalInscription: string
              phoneCountryCode: string
              phoneNumber: string
              postalCode: string
              province: string
              state: string
              stateInscription: string
              streetName: string
              streetNumber: string
        currencyCode: string
        gsiOrgCode: string
        id: string
        isIntentToPay: false
        languageCode: string
        organizationId: string
        paymentGateway:
            merchantDefinedData:
                cloudAccountName: string
                promoType: string
        paymentOptions:
            - creditCardType: string
              emailAddress: string
              extBillingAgreementId: string
              firstName: string
              lastDigits: string
              lastName: string
              nameOnCard: string
              paymentMethod: string
              timeExpiration: string
              walletInstrumentId: string
              walletTransactionId: string
        planType: string
        shipToCustAcctRoleId: string
        shipToCustAcctSiteId: string
        subscriptionPlanNumber: string
        taxInfo:
            noTaxReasonCode: string
            noTaxReasonCodeDetails: string
            taxCnpj: string
            taxPayerId: string
            taxRegNumber: string
        timePersonalToCorporateConv: string
        timePlanUpgrade: string
        timeStart: string
        upgradeState: string
        upgradeStateDetails: string
    subscriptionId: string
Copy

Subscription Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Subscription resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) The OCID of the compartment.
Email This property is required. string
(Updatable) User email
OspHomeRegion This property is required. string
(Updatable) The home region's public name of the logged in user.
SubscriptionDetails This property is required. SubscriptionSubscription
(Updatable) Subscription details object which extends the SubscriptionSummary
SubscriptionId
This property is required.
Changes to this property will trigger replacement.
string

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId This property is required. string
(Updatable) The OCID of the compartment.
Email This property is required. string
(Updatable) User email
OspHomeRegion This property is required. string
(Updatable) The home region's public name of the logged in user.
Subscription This property is required. SubscriptionSubscriptionArgs
(Updatable) Subscription details object which extends the SubscriptionSummary
SubscriptionId
This property is required.
Changes to this property will trigger replacement.
string

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. String
(Updatable) The OCID of the compartment.
email This property is required. String
(Updatable) User email
ospHomeRegion This property is required. String
(Updatable) The home region's public name of the logged in user.
subscription This property is required. SubscriptionSubscription
(Updatable) Subscription details object which extends the SubscriptionSummary
subscriptionId
This property is required.
Changes to this property will trigger replacement.
String

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. string
(Updatable) The OCID of the compartment.
email This property is required. string
(Updatable) User email
ospHomeRegion This property is required. string
(Updatable) The home region's public name of the logged in user.
subscription This property is required. SubscriptionSubscription
(Updatable) Subscription details object which extends the SubscriptionSummary
subscriptionId
This property is required.
Changes to this property will trigger replacement.
string

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id This property is required. str
(Updatable) The OCID of the compartment.
email This property is required. str
(Updatable) User email
osp_home_region This property is required. str
(Updatable) The home region's public name of the logged in user.
subscription This property is required. ospgateway.SubscriptionSubscriptionArgs
(Updatable) Subscription details object which extends the SubscriptionSummary
subscription_id
This property is required.
Changes to this property will trigger replacement.
str

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId This property is required. String
(Updatable) The OCID of the compartment.
email This property is required. String
(Updatable) User email
ospHomeRegion This property is required. String
(Updatable) The home region's public name of the logged in user.
subscription This property is required. Property Map
(Updatable) Subscription details object which extends the SubscriptionSummary
subscriptionId
This property is required.
Changes to this property will trigger replacement.
String

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

All input properties are implicitly available as output properties. Additionally, the Subscription resource produces the following output properties:

AccountType string
Account type.
BillToCustAccountId string
Bill to customer Account id.
BillingAddresses List<SubscriptionBillingAddress>
Address details model.
CurrencyCode string
Currency code
GsiOrgCode string
GSI Subscription external code.
Id string
The provider-assigned unique ID for this managed resource.
IsIntentToPay bool
Payment intension.
LanguageCode string
Language short code (en, de, hu, etc)
OrganizationId string
GSI organization external identifier.
PaymentGateways List<SubscriptionPaymentGateway>
Payment gateway details.
PaymentOptions List<SubscriptionPaymentOption>
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<SubscriptionTaxInfo>
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 []SubscriptionBillingAddress
Address details model.
CurrencyCode string
Currency code
GsiOrgCode string
GSI Subscription external code.
Id string
The provider-assigned unique ID for this managed resource.
IsIntentToPay bool
Payment intension.
LanguageCode string
Language short code (en, de, hu, etc)
OrganizationId string
GSI organization external identifier.
PaymentGateways []SubscriptionPaymentGateway
Payment gateway details.
PaymentOptions []SubscriptionPaymentOption
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 []SubscriptionTaxInfo
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<SubscriptionBillingAddress>
Address details model.
currencyCode String
Currency code
gsiOrgCode String
GSI Subscription external code.
id String
The provider-assigned unique ID for this managed resource.
isIntentToPay Boolean
Payment intension.
languageCode String
Language short code (en, de, hu, etc)
organizationId String
GSI organization external identifier.
paymentGateways List<SubscriptionPaymentGateway>
Payment gateway details.
paymentOptions List<SubscriptionPaymentOption>
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<SubscriptionTaxInfo>
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 SubscriptionBillingAddress[]
Address details model.
currencyCode string
Currency code
gsiOrgCode string
GSI Subscription external code.
id string
The provider-assigned unique ID for this managed resource.
isIntentToPay boolean
Payment intension.
languageCode string
Language short code (en, de, hu, etc)
organizationId string
GSI organization external identifier.
paymentGateways SubscriptionPaymentGateway[]
Payment gateway details.
paymentOptions SubscriptionPaymentOption[]
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 SubscriptionTaxInfo[]
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[ospgateway.SubscriptionBillingAddress]
Address details model.
currency_code str
Currency code
gsi_org_code str
GSI Subscription external code.
id str
The provider-assigned unique ID for this managed resource.
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[ospgateway.SubscriptionPaymentGateway]
Payment gateway details.
payment_options Sequence[ospgateway.SubscriptionPaymentOption]
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[ospgateway.SubscriptionTaxInfo]
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
The provider-assigned unique ID for this managed resource.
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)

Look up Existing Subscription Resource

Get an existing Subscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SubscriptionState, opts?: CustomResourceOptions): Subscription
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_type: Optional[str] = None,
        bill_to_cust_account_id: Optional[str] = None,
        billing_addresses: Optional[Sequence[_ospgateway.SubscriptionBillingAddressArgs]] = None,
        compartment_id: Optional[str] = None,
        currency_code: Optional[str] = None,
        email: Optional[str] = None,
        gsi_org_code: Optional[str] = None,
        is_intent_to_pay: Optional[bool] = None,
        language_code: Optional[str] = None,
        organization_id: Optional[str] = None,
        osp_home_region: Optional[str] = None,
        payment_gateways: Optional[Sequence[_ospgateway.SubscriptionPaymentGatewayArgs]] = None,
        payment_options: Optional[Sequence[_ospgateway.SubscriptionPaymentOptionArgs]] = None,
        plan_type: Optional[str] = None,
        ship_to_cust_acct_role_id: Optional[str] = None,
        ship_to_cust_acct_site_id: Optional[str] = None,
        subscription: Optional[_ospgateway.SubscriptionSubscriptionArgs] = None,
        subscription_id: Optional[str] = None,
        subscription_plan_number: Optional[str] = None,
        tax_infos: Optional[Sequence[_ospgateway.SubscriptionTaxInfoArgs]] = None,
        time_personal_to_corporate_conv: Optional[str] = None,
        time_plan_upgrade: Optional[str] = None,
        time_start: Optional[str] = None,
        upgrade_state: Optional[str] = None,
        upgrade_state_details: Optional[str] = None) -> Subscription
func GetSubscription(ctx *Context, name string, id IDInput, state *SubscriptionState, opts ...ResourceOption) (*Subscription, error)
public static Subscription Get(string name, Input<string> id, SubscriptionState? state, CustomResourceOptions? opts = null)
public static Subscription get(String name, Output<String> id, SubscriptionState state, CustomResourceOptions options)
resources:  _:    type: oci:OspGateway:Subscription    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccountType string
Account type.
BillToCustAccountId string
Bill to customer Account id.
BillingAddresses List<SubscriptionBillingAddress>
Address details model.
CompartmentId string
(Updatable) The OCID of the compartment.
CurrencyCode string
Currency code
Email string
(Updatable) User email
GsiOrgCode string
GSI Subscription external code.
IsIntentToPay bool
Payment intension.
LanguageCode string
Language short code (en, de, hu, etc)
OrganizationId string
GSI organization external identifier.
OspHomeRegion string
(Updatable) The home region's public name of the logged in user.
PaymentGateways List<SubscriptionPaymentGateway>
Payment gateway details.
PaymentOptions List<SubscriptionPaymentOption>
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.
SubscriptionDetails SubscriptionSubscription
(Updatable) Subscription details object which extends the SubscriptionSummary
SubscriptionId Changes to this property will trigger replacement. string

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

SubscriptionPlanNumber string
Subscription plan number.
TaxInfos List<SubscriptionTaxInfo>
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 []SubscriptionBillingAddressArgs
Address details model.
CompartmentId string
(Updatable) The OCID of the compartment.
CurrencyCode string
Currency code
Email string
(Updatable) User email
GsiOrgCode string
GSI Subscription external code.
IsIntentToPay bool
Payment intension.
LanguageCode string
Language short code (en, de, hu, etc)
OrganizationId string
GSI organization external identifier.
OspHomeRegion string
(Updatable) The home region's public name of the logged in user.
PaymentGateways []SubscriptionPaymentGatewayArgs
Payment gateway details.
PaymentOptions []SubscriptionPaymentOptionArgs
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.
Subscription SubscriptionSubscriptionArgs
(Updatable) Subscription details object which extends the SubscriptionSummary
SubscriptionId Changes to this property will trigger replacement. string

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

SubscriptionPlanNumber string
Subscription plan number.
TaxInfos []SubscriptionTaxInfoArgs
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<SubscriptionBillingAddress>
Address details model.
compartmentId String
(Updatable) The OCID of the compartment.
currencyCode String
Currency code
email String
(Updatable) User email
gsiOrgCode String
GSI Subscription external code.
isIntentToPay Boolean
Payment intension.
languageCode String
Language short code (en, de, hu, etc)
organizationId String
GSI organization external identifier.
ospHomeRegion String
(Updatable) The home region's public name of the logged in user.
paymentGateways List<SubscriptionPaymentGateway>
Payment gateway details.
paymentOptions List<SubscriptionPaymentOption>
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.
subscription SubscriptionSubscription
(Updatable) Subscription details object which extends the SubscriptionSummary
subscriptionId Changes to this property will trigger replacement. String

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

subscriptionPlanNumber String
Subscription plan number.
taxInfos List<SubscriptionTaxInfo>
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 SubscriptionBillingAddress[]
Address details model.
compartmentId string
(Updatable) The OCID of the compartment.
currencyCode string
Currency code
email string
(Updatable) User email
gsiOrgCode string
GSI Subscription external code.
isIntentToPay boolean
Payment intension.
languageCode string
Language short code (en, de, hu, etc)
organizationId string
GSI organization external identifier.
ospHomeRegion string
(Updatable) The home region's public name of the logged in user.
paymentGateways SubscriptionPaymentGateway[]
Payment gateway details.
paymentOptions SubscriptionPaymentOption[]
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.
subscription SubscriptionSubscription
(Updatable) Subscription details object which extends the SubscriptionSummary
subscriptionId Changes to this property will trigger replacement. string

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

subscriptionPlanNumber string
Subscription plan number.
taxInfos SubscriptionTaxInfo[]
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[ospgateway.SubscriptionBillingAddressArgs]
Address details model.
compartment_id str
(Updatable) The OCID of the compartment.
currency_code str
Currency code
email str
(Updatable) User email
gsi_org_code str
GSI Subscription external code.
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
(Updatable) The home region's public name of the logged in user.
payment_gateways Sequence[ospgateway.SubscriptionPaymentGatewayArgs]
Payment gateway details.
payment_options Sequence[ospgateway.SubscriptionPaymentOptionArgs]
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 ospgateway.SubscriptionSubscriptionArgs
(Updatable) Subscription details object which extends the SubscriptionSummary
subscription_id Changes to this property will trigger replacement. str

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

subscription_plan_number str
Subscription plan number.
tax_infos Sequence[ospgateway.SubscriptionTaxInfoArgs]
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
(Updatable) The OCID of the compartment.
currencyCode String
Currency code
email String
(Updatable) User email
gsiOrgCode String
GSI Subscription external code.
isIntentToPay Boolean
Payment intension.
languageCode String
Language short code (en, de, hu, etc)
organizationId String
GSI organization external identifier.
ospHomeRegion String
(Updatable) The home region's public name of the logged in user.
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.
subscription Property Map
(Updatable) Subscription details object which extends the SubscriptionSummary
subscriptionId Changes to this property will trigger replacement. String

Subscription id(OCID).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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)

Supporting Types

SubscriptionBillingAddress
, SubscriptionBillingAddressArgs

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.

SubscriptionPaymentGateway
, SubscriptionPaymentGatewayArgs

SubscriptionPaymentGatewayMerchantDefinedData
, SubscriptionPaymentGatewayMerchantDefinedDataArgs

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.

SubscriptionPaymentOption
, SubscriptionPaymentOptionArgs

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.

SubscriptionSubscription
, SubscriptionSubscriptionArgs

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

SubscriptionSubscriptionBillingAddress
, SubscriptionSubscriptionBillingAddressArgs

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

SubscriptionSubscriptionPaymentGateway
, SubscriptionSubscriptionPaymentGatewayArgs

merchantDefinedData Property Map
(Updatable) Merchant details.

SubscriptionSubscriptionPaymentGatewayMerchantDefinedData
, SubscriptionSubscriptionPaymentGatewayMerchantDefinedDataArgs

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

SubscriptionSubscriptionPaymentOption
, SubscriptionSubscriptionPaymentOptionArgs

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

SubscriptionSubscriptionTaxInfo
, SubscriptionSubscriptionTaxInfoArgs

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

SubscriptionTaxInfo
, SubscriptionTaxInfoArgs

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.

Import

Subscriptions can be imported using the id, e.g.

$ pulumi import oci:OspGateway/subscription:Subscription test_subscription "subscriptions/{subscriptionId}/compartmentId/{compartmentId}/ospHomeRegion/{ospHomeRegion}"
Copy

To learn more about importing existing cloud resources, see Importing resources.

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
pulumi/pulumi-oci