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

oci.OspGateway.getSubscriptions

Explore with Pulumi AI

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

This data source provides the list of Subscriptions in Oracle Cloud Infrastructure Osp Gateway service.

Get the subscription data for the compartment

Example Usage

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

const testSubscriptions = oci.OspGateway.getSubscriptions({
    compartmentId: compartmentId,
    ospHomeRegion: subscriptionOspHomeRegion,
});
Copy
import pulumi
import pulumi_oci as oci

test_subscriptions = oci.OspGateway.get_subscriptions(compartment_id=compartment_id,
    osp_home_region=subscription_osp_home_region)
Copy
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.GetSubscriptions(ctx, &ospgateway.GetSubscriptionsArgs{
			CompartmentId: compartmentId,
			OspHomeRegion: subscriptionOspHomeRegion,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSubscriptions = Oci.OspGateway.GetSubscriptions.Invoke(new()
    {
        CompartmentId = compartmentId,
        OspHomeRegion = subscriptionOspHomeRegion,
    });

});
Copy
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.GetSubscriptionsArgs;
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 testSubscriptions = OspGatewayFunctions.getSubscriptions(GetSubscriptionsArgs.builder()
            .compartmentId(compartmentId)
            .ospHomeRegion(subscriptionOspHomeRegion)
            .build());

    }
}
Copy
variables:
  testSubscriptions:
    fn::invoke:
      function: oci:OspGateway:getSubscriptions
      arguments:
        compartmentId: ${compartmentId}
        ospHomeRegion: ${subscriptionOspHomeRegion}
Copy

Using getSubscriptions

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 getSubscriptions(args: GetSubscriptionsArgs, opts?: InvokeOptions): Promise<GetSubscriptionsResult>
function getSubscriptionsOutput(args: GetSubscriptionsOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionsResult>
Copy
def get_subscriptions(compartment_id: Optional[str] = None,
                      filters: Optional[Sequence[_ospgateway.GetSubscriptionsFilter]] = None,
                      osp_home_region: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSubscriptionsResult
def get_subscriptions_output(compartment_id: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_ospgateway.GetSubscriptionsFilterArgs]]]] = None,
                      osp_home_region: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionsResult]
Copy
func GetSubscriptions(ctx *Context, args *GetSubscriptionsArgs, opts ...InvokeOption) (*GetSubscriptionsResult, error)
func GetSubscriptionsOutput(ctx *Context, args *GetSubscriptionsOutputArgs, opts ...InvokeOption) GetSubscriptionsResultOutput
Copy

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

public static class GetSubscriptions 
{
    public static Task<GetSubscriptionsResult> InvokeAsync(GetSubscriptionsArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriptionsResult> Invoke(GetSubscriptionsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSubscriptionsResult> getSubscriptions(GetSubscriptionsArgs args, InvokeOptions options)
public static Output<GetSubscriptionsResult> getSubscriptions(GetSubscriptionsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:OspGateway/getSubscriptions:getSubscriptions
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CompartmentId This property is required. string
The OCID of the compartment.
OspHomeRegion This property is required. string
The home region's public name of the logged in user.
Filters Changes to this property will trigger replacement. List<GetSubscriptionsFilter>
CompartmentId This property is required. string
The OCID of the compartment.
OspHomeRegion This property is required. string
The home region's public name of the logged in user.
Filters Changes to this property will trigger replacement. []GetSubscriptionsFilter
compartmentId This property is required. String
The OCID of the compartment.
ospHomeRegion This property is required. String
The home region's public name of the logged in user.
filters Changes to this property will trigger replacement. List<GetSubscriptionsFilter>
compartmentId This property is required. string
The OCID of the compartment.
ospHomeRegion This property is required. string
The home region's public name of the logged in user.
filters Changes to this property will trigger replacement. GetSubscriptionsFilter[]
compartment_id This property is required. str
The OCID of the compartment.
osp_home_region This property is required. str
The home region's public name of the logged in user.
filters Changes to this property will trigger replacement. Sequence[ospgateway.GetSubscriptionsFilter]
compartmentId This property is required. String
The OCID of the compartment.
ospHomeRegion This property is required. String
The home region's public name of the logged in user.
filters Changes to this property will trigger replacement. List<Property Map>

getSubscriptions Result

The following output properties are available:

CompartmentId string
Id string
The provider-assigned unique ID for this managed resource.
OspHomeRegion string
SubscriptionCollections List<GetSubscriptionsSubscriptionCollection>
The list of subscription_collection.
Filters List<GetSubscriptionsFilter>
CompartmentId string
Id string
The provider-assigned unique ID for this managed resource.
OspHomeRegion string
SubscriptionCollections []GetSubscriptionsSubscriptionCollection
The list of subscription_collection.
Filters []GetSubscriptionsFilter
compartmentId String
id String
The provider-assigned unique ID for this managed resource.
ospHomeRegion String
subscriptionCollections List<GetSubscriptionsSubscriptionCollection>
The list of subscription_collection.
filters List<GetSubscriptionsFilter>
compartmentId string
id string
The provider-assigned unique ID for this managed resource.
ospHomeRegion string
subscriptionCollections GetSubscriptionsSubscriptionCollection[]
The list of subscription_collection.
filters GetSubscriptionsFilter[]
compartmentId String
id String
The provider-assigned unique ID for this managed resource.
ospHomeRegion String
subscriptionCollections List<Property Map>
The list of subscription_collection.
filters List<Property Map>

Supporting Types

GetSubscriptionsFilter

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

GetSubscriptionsSubscriptionCollection

items This property is required. List<Property Map>

GetSubscriptionsSubscriptionCollectionItem

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

GetSubscriptionsSubscriptionCollectionItemBillingAddress

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

GetSubscriptionsSubscriptionCollectionItemPaymentGateway

merchantDefinedDatas This property is required. List<Property Map>
Merchant details.

GetSubscriptionsSubscriptionCollectionItemPaymentGatewayMerchantDefinedData

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

GetSubscriptionsSubscriptionCollectionItemPaymentOption

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

GetSubscriptionsSubscriptionCollectionItemSubscription

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

GetSubscriptionsSubscriptionCollectionItemSubscriptionBillingAddress

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

GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentGateway

merchantDefinedDatas This property is required. List<Property Map>
Merchant details.

GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentGatewayMerchantDefinedData

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

GetSubscriptionsSubscriptionCollectionItemSubscriptionPaymentOption

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

GetSubscriptionsSubscriptionCollectionItemSubscriptionTaxInfo

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

GetSubscriptionsSubscriptionCollectionItemTaxInfo

Giro This property is required. string
Companies' GIRO code
NoTaxReasonCode This property is required. string
Tax exemption reason code.
NoTaxReasonCodeDetails This property is required. string
Tax exemption reason description.
TaxCnpj This property is required. string
Brazilian companies' CNPJ number.
TaxPayerId This property is required. string
Tay payer identifier.
TaxRegNumber This property is required. string
Tax registration number.
Giro This property is required. string
Companies' GIRO code
NoTaxReasonCode This property is required. string
Tax exemption reason code.
NoTaxReasonCodeDetails This property is required. string
Tax exemption reason description.
TaxCnpj This property is required. string
Brazilian companies' CNPJ number.
TaxPayerId This property is required. string
Tay payer identifier.
TaxRegNumber This property is required. string
Tax registration number.
giro This property is required. String
Companies' GIRO code
noTaxReasonCode This property is required. String
Tax exemption reason code.
noTaxReasonCodeDetails This property is required. String
Tax exemption reason description.
taxCnpj This property is required. String
Brazilian companies' CNPJ number.
taxPayerId This property is required. String
Tay payer identifier.
taxRegNumber This property is required. String
Tax registration number.
giro This property is required. string
Companies' GIRO code
noTaxReasonCode This property is required. string
Tax exemption reason code.
noTaxReasonCodeDetails This property is required. string
Tax exemption reason description.
taxCnpj This property is required. string
Brazilian companies' CNPJ number.
taxPayerId This property is required. string
Tay payer identifier.
taxRegNumber This property is required. string
Tax registration number.
giro This property is required. str
Companies' GIRO code
no_tax_reason_code This property is required. str
Tax exemption reason code.
no_tax_reason_code_details This property is required. str
Tax exemption reason description.
tax_cnpj This property is required. str
Brazilian companies' CNPJ number.
tax_payer_id This property is required. str
Tay payer identifier.
tax_reg_number This property is required. str
Tax registration number.
giro This property is required. String
Companies' GIRO code
noTaxReasonCode This property is required. String
Tax exemption reason code.
noTaxReasonCodeDetails This property is required. String
Tax exemption reason description.
taxCnpj This property is required. String
Brazilian companies' CNPJ number.
taxPayerId This property is required. String
Tay payer identifier.
taxRegNumber This property is required. 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.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi