stripe

package
v0.0.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 14, 2023 License: MPL-2.0 Imports: 7 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing Stripe resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Card

type Card struct {
	pulumi.CustomResourceState

	// Map(String). Address map with fields related to the address: `line1`, `line2`, `city`, `state`
	// , `zip` and `country`.
	Address pulumi.StringMapOutput `pulumi:"address"`
	// String. If address `line1` was provided, results of the check: `pass`, `fail`, `unavailable`,
	// or `unchecked`.
	AddressLine1Check pulumi.StringOutput `pulumi:"addressLine1Check"`
	// String. If address `zip` was provided, results of the check: `pass`, `fail`, `unavailable`,
	// or `unchecked`.
	AddressZipCheck pulumi.StringOutput `pulumi:"addressZipCheck"`
	// List(String). A set of available payout methods for this card. Only values from this set
	// should be passed as the method when creating a payout.
	AvailablePayoutMethods pulumi.StringArrayOutput `pulumi:"availablePayoutMethods"`
	// String. Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`
	// , `Visa`, or `Unknown`.
	Brand pulumi.StringOutput `pulumi:"brand"`
	// String. Two-letter ISO code representing the country of the card. You could use this attribute to get a
	// sense of the international breakdown of cards you’ve collected.
	Country pulumi.StringOutput `pulumi:"country"`
	// String. The customer that this card belongs to.
	Customer pulumi.StringOutput `pulumi:"customer"`
	// Int. Card security code. Highly recommended to always include this value, but it's required only
	// for accounts based in European countries.
	Cvc pulumi.IntPtrOutput `pulumi:"cvc"`
	// String. If a `cvc` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A
	// result of `unchecked` indicates that CVC was provided but hasn’t been checked yet
	CvcCheck pulumi.StringOutput `pulumi:"cvcCheck"`
	// Int. Number representing the card's expiration month.
	ExpMonth pulumi.IntOutput `pulumi:"expMonth"`
	// Int. Four-digit number representing the card's expiration year.
	ExpYear pulumi.IntOutput `pulumi:"expYear"`
	// String. Uniquely identifies this particular card number. You can use this attribute to check whether
	// two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize
	// card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card
	// number.
	Fingerprint pulumi.StringOutput `pulumi:"fingerprint"`
	// String. Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
	Funding pulumi.StringOutput `pulumi:"funding"`
	// String. The last four digits of the card.
	Last4 pulumi.StringOutput `pulumi:"last4"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for
	// storing additional information about the object in a structured format.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// String. Cardholder name.
	Name pulumi.StringOutput `pulumi:"name"`
	// String. The card number, as a string without any separators.
	Number pulumi.StringOutput `pulumi:"number"`
	// String. If the card number is tokenized, this is the method that was used. Can
	// be `androidPay` (includes Google Pay), `applePay`, `masterpass`, `visaCheckout`, or `null`.
	TokenizationMethod pulumi.StringOutput `pulumi:"tokenizationMethod"`
}

## Example Usage

```go package main

import (

"github.com/georgegebbett/pulumi-stripe/sdk/go/stripe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stripe.NewCard(ctx, "cardCard", &stripe.CardArgs{
			Customer: pulumi.Any(stripe_customer.Customer.Id),
			Number:   pulumi.String("4242424242424242"),
			Cvc:      pulumi.Int(123),
			ExpMonth: pulumi.Int(8),
			ExpYear:  pulumi.Int(2030),
		})
		if err != nil {
			return err
		}
		_, err = stripe.NewCard(ctx, "cardIndex/cardCard", &stripe.CardArgs{
			Customer: pulumi.Any(stripe_customer.Customer.Id),
			Number:   pulumi.String("4242424242424242"),
			Cvc:      pulumi.Int(123),
			ExpMonth: pulumi.Int(8),
			ExpYear:  pulumi.Int(2030),
			Address: pulumi.StringMap{
				"line1":   pulumi.String("1 The Best Street"),
				"line2":   pulumi.String("Apartment 401"),
				"city":    pulumi.String("Sydney"),
				"state":   pulumi.String("NSW"),
				"zip":     pulumi.String("2000"),
				"country": pulumi.String("Australia"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetCard

func GetCard(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CardState, opts ...pulumi.ResourceOption) (*Card, error)

GetCard gets an existing Card resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCard

func NewCard(ctx *pulumi.Context,
	name string, args *CardArgs, opts ...pulumi.ResourceOption) (*Card, error)

NewCard registers a new resource with the given unique name, arguments, and options.

func (*Card) ElementType

func (*Card) ElementType() reflect.Type

func (*Card) ToCardOutput

func (i *Card) ToCardOutput() CardOutput

func (*Card) ToCardOutputWithContext

func (i *Card) ToCardOutputWithContext(ctx context.Context) CardOutput

type CardArgs

type CardArgs struct {
	// Map(String). Address map with fields related to the address: `line1`, `line2`, `city`, `state`
	// , `zip` and `country`.
	Address pulumi.StringMapInput
	// String. The customer that this card belongs to.
	Customer pulumi.StringInput
	// Int. Card security code. Highly recommended to always include this value, but it's required only
	// for accounts based in European countries.
	Cvc pulumi.IntPtrInput
	// Int. Number representing the card's expiration month.
	ExpMonth pulumi.IntInput
	// Int. Four-digit number representing the card's expiration year.
	ExpYear pulumi.IntInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for
	// storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. Cardholder name.
	Name pulumi.StringPtrInput
	// String. The card number, as a string without any separators.
	Number pulumi.StringInput
}

The set of arguments for constructing a Card resource.

func (CardArgs) ElementType

func (CardArgs) ElementType() reflect.Type

type CardArray

type CardArray []CardInput

func (CardArray) ElementType

func (CardArray) ElementType() reflect.Type

func (CardArray) ToCardArrayOutput

func (i CardArray) ToCardArrayOutput() CardArrayOutput

func (CardArray) ToCardArrayOutputWithContext

func (i CardArray) ToCardArrayOutputWithContext(ctx context.Context) CardArrayOutput

type CardArrayInput

type CardArrayInput interface {
	pulumi.Input

	ToCardArrayOutput() CardArrayOutput
	ToCardArrayOutputWithContext(context.Context) CardArrayOutput
}

CardArrayInput is an input type that accepts CardArray and CardArrayOutput values. You can construct a concrete instance of `CardArrayInput` via:

CardArray{ CardArgs{...} }

type CardArrayOutput

type CardArrayOutput struct{ *pulumi.OutputState }

func (CardArrayOutput) ElementType

func (CardArrayOutput) ElementType() reflect.Type

func (CardArrayOutput) Index

func (CardArrayOutput) ToCardArrayOutput

func (o CardArrayOutput) ToCardArrayOutput() CardArrayOutput

func (CardArrayOutput) ToCardArrayOutputWithContext

func (o CardArrayOutput) ToCardArrayOutputWithContext(ctx context.Context) CardArrayOutput

type CardInput

type CardInput interface {
	pulumi.Input

	ToCardOutput() CardOutput
	ToCardOutputWithContext(ctx context.Context) CardOutput
}

type CardMap

type CardMap map[string]CardInput

func (CardMap) ElementType

func (CardMap) ElementType() reflect.Type

func (CardMap) ToCardMapOutput

func (i CardMap) ToCardMapOutput() CardMapOutput

func (CardMap) ToCardMapOutputWithContext

func (i CardMap) ToCardMapOutputWithContext(ctx context.Context) CardMapOutput

type CardMapInput

type CardMapInput interface {
	pulumi.Input

	ToCardMapOutput() CardMapOutput
	ToCardMapOutputWithContext(context.Context) CardMapOutput
}

CardMapInput is an input type that accepts CardMap and CardMapOutput values. You can construct a concrete instance of `CardMapInput` via:

CardMap{ "key": CardArgs{...} }

type CardMapOutput

type CardMapOutput struct{ *pulumi.OutputState }

func (CardMapOutput) ElementType

func (CardMapOutput) ElementType() reflect.Type

func (CardMapOutput) MapIndex

func (CardMapOutput) ToCardMapOutput

func (o CardMapOutput) ToCardMapOutput() CardMapOutput

func (CardMapOutput) ToCardMapOutputWithContext

func (o CardMapOutput) ToCardMapOutputWithContext(ctx context.Context) CardMapOutput

type CardOutput

type CardOutput struct{ *pulumi.OutputState }

func (CardOutput) Address

func (o CardOutput) Address() pulumi.StringMapOutput

Map(String). Address map with fields related to the address: `line1`, `line2`, `city`, `state` , `zip` and `country`.

func (CardOutput) AddressLine1Check

func (o CardOutput) AddressLine1Check() pulumi.StringOutput

String. If address `line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

func (CardOutput) AddressZipCheck

func (o CardOutput) AddressZipCheck() pulumi.StringOutput

String. If address `zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

func (CardOutput) AvailablePayoutMethods

func (o CardOutput) AvailablePayoutMethods() pulumi.StringArrayOutput

List(String). A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.

func (CardOutput) Brand

func (o CardOutput) Brand() pulumi.StringOutput

String. Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay` , `Visa`, or `Unknown`.

func (CardOutput) Country

func (o CardOutput) Country() pulumi.StringOutput

String. Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

func (CardOutput) Customer

func (o CardOutput) Customer() pulumi.StringOutput

String. The customer that this card belongs to.

func (CardOutput) Cvc

func (o CardOutput) Cvc() pulumi.IntPtrOutput

Int. Card security code. Highly recommended to always include this value, but it's required only for accounts based in European countries.

func (CardOutput) CvcCheck

func (o CardOutput) CvcCheck() pulumi.StringOutput

String. If a `cvc` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of `unchecked` indicates that CVC was provided but hasn’t been checked yet

func (CardOutput) ElementType

func (CardOutput) ElementType() reflect.Type

func (CardOutput) ExpMonth

func (o CardOutput) ExpMonth() pulumi.IntOutput

Int. Number representing the card's expiration month.

func (CardOutput) ExpYear

func (o CardOutput) ExpYear() pulumi.IntOutput

Int. Four-digit number representing the card's expiration year.

func (CardOutput) Fingerprint

func (o CardOutput) Fingerprint() pulumi.StringOutput

String. Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

func (CardOutput) Funding

func (o CardOutput) Funding() pulumi.StringOutput

String. Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

func (CardOutput) Last4

func (o CardOutput) Last4() pulumi.StringOutput

String. The last four digits of the card.

func (CardOutput) Metadata

func (o CardOutput) Metadata() pulumi.StringMapOutput

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

func (CardOutput) Name

func (o CardOutput) Name() pulumi.StringOutput

String. Cardholder name.

func (CardOutput) Number

func (o CardOutput) Number() pulumi.StringOutput

String. The card number, as a string without any separators.

func (CardOutput) ToCardOutput

func (o CardOutput) ToCardOutput() CardOutput

func (CardOutput) ToCardOutputWithContext

func (o CardOutput) ToCardOutputWithContext(ctx context.Context) CardOutput

func (CardOutput) TokenizationMethod

func (o CardOutput) TokenizationMethod() pulumi.StringOutput

String. If the card number is tokenized, this is the method that was used. Can be `androidPay` (includes Google Pay), `applePay`, `masterpass`, `visaCheckout`, or `null`.

type CardState

type CardState struct {
	// Map(String). Address map with fields related to the address: `line1`, `line2`, `city`, `state`
	// , `zip` and `country`.
	Address pulumi.StringMapInput
	// String. If address `line1` was provided, results of the check: `pass`, `fail`, `unavailable`,
	// or `unchecked`.
	AddressLine1Check pulumi.StringPtrInput
	// String. If address `zip` was provided, results of the check: `pass`, `fail`, `unavailable`,
	// or `unchecked`.
	AddressZipCheck pulumi.StringPtrInput
	// List(String). A set of available payout methods for this card. Only values from this set
	// should be passed as the method when creating a payout.
	AvailablePayoutMethods pulumi.StringArrayInput
	// String. Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`
	// , `Visa`, or `Unknown`.
	Brand pulumi.StringPtrInput
	// String. Two-letter ISO code representing the country of the card. You could use this attribute to get a
	// sense of the international breakdown of cards you’ve collected.
	Country pulumi.StringPtrInput
	// String. The customer that this card belongs to.
	Customer pulumi.StringPtrInput
	// Int. Card security code. Highly recommended to always include this value, but it's required only
	// for accounts based in European countries.
	Cvc pulumi.IntPtrInput
	// String. If a `cvc` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A
	// result of `unchecked` indicates that CVC was provided but hasn’t been checked yet
	CvcCheck pulumi.StringPtrInput
	// Int. Number representing the card's expiration month.
	ExpMonth pulumi.IntPtrInput
	// Int. Four-digit number representing the card's expiration year.
	ExpYear pulumi.IntPtrInput
	// String. Uniquely identifies this particular card number. You can use this attribute to check whether
	// two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize
	// card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card
	// number.
	Fingerprint pulumi.StringPtrInput
	// String. Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
	Funding pulumi.StringPtrInput
	// String. The last four digits of the card.
	Last4 pulumi.StringPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for
	// storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. Cardholder name.
	Name pulumi.StringPtrInput
	// String. The card number, as a string without any separators.
	Number pulumi.StringPtrInput
	// String. If the card number is tokenized, this is the method that was used. Can
	// be `androidPay` (includes Google Pay), `applePay`, `masterpass`, `visaCheckout`, or `null`.
	TokenizationMethod pulumi.StringPtrInput
}

func (CardState) ElementType

func (CardState) ElementType() reflect.Type

type Coupon

type Coupon struct {
	pulumi.CustomResourceState

	// Int. Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
	AmountOff pulumi.IntPtrOutput `pulumi:"amountOff"`
	// List(String). A list of product IDs this coupon applies to.
	AppliesTos pulumi.StringArrayOutput `pulumi:"appliesTos"`
	// String. Unique string of your choice that will be used to identify this coupon when applying it to a customer.
	CouponId pulumi.StringOutput `pulumi:"couponId"`
	// String. Required if `amountOff` has been set, the three-letter ISO code for the currency of the amount to take off.
	Currency pulumi.StringPtrOutput `pulumi:"currency"`
	// String. Describes how long a customer who applies this coupon will get the discount. One of `forever`, `once`, and `repeating`.
	Duration pulumi.StringPtrOutput `pulumi:"duration"`
	// If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
	DurationInMonths pulumi.IntPtrOutput `pulumi:"durationInMonths"`
	// Int. Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
	MaxRedemptions pulumi.IntPtrOutput `pulumi:"maxRedemptions"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// String. Name of the coupon displayed to customers on for instance invoices or receipts.
	Name pulumi.StringOutput `pulumi:"name"`
	// Float. Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percentOff of 50 will make a $100 invoice $50 instead.
	PercentOff pulumi.Float64PtrOutput `pulumi:"percentOff"`
	// String. Date after which the coupon can no longer be redeemed. Expected format is in the `RFC3339`.
	RedeemBy pulumi.StringPtrOutput `pulumi:"redeemBy"`
	// Int. Number of times this coupon has been applied to a customer.
	TimesRedeemed pulumi.IntOutput `pulumi:"timesRedeemed"`
	// Bool. Taking account of the above properties, whether this coupon can still be applied to a customer.
	Valid pulumi.BoolOutput `pulumi:"valid"`
}

With this resource, you can create a coupon - [Stripe API coupon documentation](https://stripe.com/docs/api/coupons).

A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer.

A coupon has either a `percentOff` or an `amountOff` and `currency`. If you set an `amountOff`, that amount will be subtracted from any invoice’s subtotal.

For example, an invoice with a subtotal of $100 will have a final total of $0 if a coupon with an amountOff of 20000 is applied to it and an invoice with a subtotal of $300 will have a final total of $100 if a coupon with an amountOff of 20000 is applied to it.

func GetCoupon

func GetCoupon(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CouponState, opts ...pulumi.ResourceOption) (*Coupon, error)

GetCoupon gets an existing Coupon resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCoupon

func NewCoupon(ctx *pulumi.Context,
	name string, args *CouponArgs, opts ...pulumi.ResourceOption) (*Coupon, error)

NewCoupon registers a new resource with the given unique name, arguments, and options.

func (*Coupon) ElementType

func (*Coupon) ElementType() reflect.Type

func (*Coupon) ToCouponOutput

func (i *Coupon) ToCouponOutput() CouponOutput

func (*Coupon) ToCouponOutputWithContext

func (i *Coupon) ToCouponOutputWithContext(ctx context.Context) CouponOutput

type CouponArgs

type CouponArgs struct {
	// Int. Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
	AmountOff pulumi.IntPtrInput
	// List(String). A list of product IDs this coupon applies to.
	AppliesTos pulumi.StringArrayInput
	// String. Unique string of your choice that will be used to identify this coupon when applying it to a customer.
	CouponId pulumi.StringPtrInput
	// String. Required if `amountOff` has been set, the three-letter ISO code for the currency of the amount to take off.
	Currency pulumi.StringPtrInput
	// String. Describes how long a customer who applies this coupon will get the discount. One of `forever`, `once`, and `repeating`.
	Duration pulumi.StringPtrInput
	// If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
	DurationInMonths pulumi.IntPtrInput
	// Int. Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
	MaxRedemptions pulumi.IntPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. Name of the coupon displayed to customers on for instance invoices or receipts.
	Name pulumi.StringPtrInput
	// Float. Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percentOff of 50 will make a $100 invoice $50 instead.
	PercentOff pulumi.Float64PtrInput
	// String. Date after which the coupon can no longer be redeemed. Expected format is in the `RFC3339`.
	RedeemBy pulumi.StringPtrInput
}

The set of arguments for constructing a Coupon resource.

func (CouponArgs) ElementType

func (CouponArgs) ElementType() reflect.Type

type CouponArray

type CouponArray []CouponInput

func (CouponArray) ElementType

func (CouponArray) ElementType() reflect.Type

func (CouponArray) ToCouponArrayOutput

func (i CouponArray) ToCouponArrayOutput() CouponArrayOutput

func (CouponArray) ToCouponArrayOutputWithContext

func (i CouponArray) ToCouponArrayOutputWithContext(ctx context.Context) CouponArrayOutput

type CouponArrayInput

type CouponArrayInput interface {
	pulumi.Input

	ToCouponArrayOutput() CouponArrayOutput
	ToCouponArrayOutputWithContext(context.Context) CouponArrayOutput
}

CouponArrayInput is an input type that accepts CouponArray and CouponArrayOutput values. You can construct a concrete instance of `CouponArrayInput` via:

CouponArray{ CouponArgs{...} }

type CouponArrayOutput

type CouponArrayOutput struct{ *pulumi.OutputState }

func (CouponArrayOutput) ElementType

func (CouponArrayOutput) ElementType() reflect.Type

func (CouponArrayOutput) Index

func (CouponArrayOutput) ToCouponArrayOutput

func (o CouponArrayOutput) ToCouponArrayOutput() CouponArrayOutput

func (CouponArrayOutput) ToCouponArrayOutputWithContext

func (o CouponArrayOutput) ToCouponArrayOutputWithContext(ctx context.Context) CouponArrayOutput

type CouponInput

type CouponInput interface {
	pulumi.Input

	ToCouponOutput() CouponOutput
	ToCouponOutputWithContext(ctx context.Context) CouponOutput
}

type CouponMap

type CouponMap map[string]CouponInput

func (CouponMap) ElementType

func (CouponMap) ElementType() reflect.Type

func (CouponMap) ToCouponMapOutput

func (i CouponMap) ToCouponMapOutput() CouponMapOutput

func (CouponMap) ToCouponMapOutputWithContext

func (i CouponMap) ToCouponMapOutputWithContext(ctx context.Context) CouponMapOutput

type CouponMapInput

type CouponMapInput interface {
	pulumi.Input

	ToCouponMapOutput() CouponMapOutput
	ToCouponMapOutputWithContext(context.Context) CouponMapOutput
}

CouponMapInput is an input type that accepts CouponMap and CouponMapOutput values. You can construct a concrete instance of `CouponMapInput` via:

CouponMap{ "key": CouponArgs{...} }

type CouponMapOutput

type CouponMapOutput struct{ *pulumi.OutputState }

func (CouponMapOutput) ElementType

func (CouponMapOutput) ElementType() reflect.Type

func (CouponMapOutput) MapIndex

func (CouponMapOutput) ToCouponMapOutput

func (o CouponMapOutput) ToCouponMapOutput() CouponMapOutput

func (CouponMapOutput) ToCouponMapOutputWithContext

func (o CouponMapOutput) ToCouponMapOutputWithContext(ctx context.Context) CouponMapOutput

type CouponOutput

type CouponOutput struct{ *pulumi.OutputState }

func (CouponOutput) AmountOff

func (o CouponOutput) AmountOff() pulumi.IntPtrOutput

Int. Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.

func (CouponOutput) AppliesTos

func (o CouponOutput) AppliesTos() pulumi.StringArrayOutput

List(String). A list of product IDs this coupon applies to.

func (CouponOutput) CouponId

func (o CouponOutput) CouponId() pulumi.StringOutput

String. Unique string of your choice that will be used to identify this coupon when applying it to a customer.

func (CouponOutput) Currency

func (o CouponOutput) Currency() pulumi.StringPtrOutput

String. Required if `amountOff` has been set, the three-letter ISO code for the currency of the amount to take off.

func (CouponOutput) Duration

func (o CouponOutput) Duration() pulumi.StringPtrOutput

String. Describes how long a customer who applies this coupon will get the discount. One of `forever`, `once`, and `repeating`.

func (CouponOutput) DurationInMonths

func (o CouponOutput) DurationInMonths() pulumi.IntPtrOutput

If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.

func (CouponOutput) ElementType

func (CouponOutput) ElementType() reflect.Type

func (CouponOutput) MaxRedemptions

func (o CouponOutput) MaxRedemptions() pulumi.IntPtrOutput

Int. Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.

func (CouponOutput) Metadata

func (o CouponOutput) Metadata() pulumi.StringMapOutput

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

func (CouponOutput) Name

func (o CouponOutput) Name() pulumi.StringOutput

String. Name of the coupon displayed to customers on for instance invoices or receipts.

func (CouponOutput) PercentOff

func (o CouponOutput) PercentOff() pulumi.Float64PtrOutput

Float. Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percentOff of 50 will make a $100 invoice $50 instead.

func (CouponOutput) RedeemBy

func (o CouponOutput) RedeemBy() pulumi.StringPtrOutput

String. Date after which the coupon can no longer be redeemed. Expected format is in the `RFC3339`.

func (CouponOutput) TimesRedeemed

func (o CouponOutput) TimesRedeemed() pulumi.IntOutput

Int. Number of times this coupon has been applied to a customer.

func (CouponOutput) ToCouponOutput

func (o CouponOutput) ToCouponOutput() CouponOutput

func (CouponOutput) ToCouponOutputWithContext

func (o CouponOutput) ToCouponOutputWithContext(ctx context.Context) CouponOutput

func (CouponOutput) Valid

func (o CouponOutput) Valid() pulumi.BoolOutput

Bool. Taking account of the above properties, whether this coupon can still be applied to a customer.

type CouponState

type CouponState struct {
	// Int. Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.
	AmountOff pulumi.IntPtrInput
	// List(String). A list of product IDs this coupon applies to.
	AppliesTos pulumi.StringArrayInput
	// String. Unique string of your choice that will be used to identify this coupon when applying it to a customer.
	CouponId pulumi.StringPtrInput
	// String. Required if `amountOff` has been set, the three-letter ISO code for the currency of the amount to take off.
	Currency pulumi.StringPtrInput
	// String. Describes how long a customer who applies this coupon will get the discount. One of `forever`, `once`, and `repeating`.
	Duration pulumi.StringPtrInput
	// If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.
	DurationInMonths pulumi.IntPtrInput
	// Int. Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
	MaxRedemptions pulumi.IntPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. Name of the coupon displayed to customers on for instance invoices or receipts.
	Name pulumi.StringPtrInput
	// Float. Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percentOff of 50 will make a $100 invoice $50 instead.
	PercentOff pulumi.Float64PtrInput
	// String. Date after which the coupon can no longer be redeemed. Expected format is in the `RFC3339`.
	RedeemBy pulumi.StringPtrInput
	// Int. Number of times this coupon has been applied to a customer.
	TimesRedeemed pulumi.IntPtrInput
	// Bool. Taking account of the above properties, whether this coupon can still be applied to a customer.
	Valid pulumi.BoolPtrInput
}

func (CouponState) ElementType

func (CouponState) ElementType() reflect.Type

type Customer

type Customer struct {
	pulumi.CustomResourceState

	// Map(String). The customer’s address, for all individual fields see: Address Fields.
	Address pulumi.StringMapOutput `pulumi:"address"`
	// Int. Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.
	Balance pulumi.IntPtrOutput `pulumi:"balance"`
	// String. The default invoice prefix generated by Stripe when not individual invoice prefix provided.
	DefaultInvoicePrefix pulumi.StringOutput `pulumi:"defaultInvoicePrefix"`
	// String. An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// String. Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
	Email pulumi.StringPtrOutput `pulumi:"email"`
	// String. The prefix for the customer used to generate unique invoice numbers. Must be `3–12 uppercase letters or numbers`.
	InvoicePrefix pulumi.StringPtrOutput `pulumi:"invoicePrefix"`
	// Map(String). Default invoice settings for this customer. For supported fields see: Invoice Settings Fields.
	InvoiceSettings pulumi.StringMapOutput `pulumi:"invoiceSettings"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// String. The customer’s full name or business name.
	Name pulumi.StringOutput `pulumi:"name"`
	// Int. The sequence to be used on the customer’s next invoice. Defaults to 1.
	NextInvoiceSequence pulumi.IntPtrOutput `pulumi:"nextInvoiceSequence"`
	// String. The customer’s phone number.
	Phone pulumi.StringPtrOutput `pulumi:"phone"`
	// List(String). Customer’s preferred languages, ordered by preference.
	PreferredLocales pulumi.StringArrayOutput `pulumi:"preferredLocales"`
	// Map(String). Mailing and shipping address for the customer. Appears on invoices emailed to this customer. For all individual fields see: Shipping Fields.
	Shipping pulumi.StringMapOutput `pulumi:"shipping"`
}

With this resource, you can create a customer - [Stripe API customer documentation](https://stripe.com/docs/api/customers).

Customer objects allow you to perform recurring charges, and to track multiple charges, that are associated with the same customer.

## Example Usage

```go package main

import (

"github.com/georgegebbett/pulumi-stripe/sdk/go/stripe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stripe.NewCustomer(ctx, "customer", &stripe.CustomerArgs{
			Balance:       pulumi.Int(10000),
			InvoicePrefix: pulumi.String("LA000"),
			InvoiceSettings: pulumi.StringMap{
				"customFieldName": pulumi.String("customFieldValue"),
				"footer":          pulumi.String("--- Lukas Aron ---"),
			},
			NextInvoiceSequence: pulumi.Int(1001),
			PreferredLocales: pulumi.StringArray{
				pulumi.String("eng"),
				pulumi.String("esp"),
			},
			Shipping: pulumi.StringMap{
				"city":        pulumi.String("Sydney"),
				"country":     pulumi.String("AU"),
				"line1":       pulumi.String("1 The Best Street"),
				"line2":       pulumi.String("Apartment 401"),
				"name":        pulumi.String("Lukas Aron"),
				"phone":       pulumi.String("+610123456789"),
				"postal_code": pulumi.String("2000"),
				"state":       pulumi.String("New South Wales"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetCustomer

func GetCustomer(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CustomerState, opts ...pulumi.ResourceOption) (*Customer, error)

GetCustomer gets an existing Customer resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCustomer

func NewCustomer(ctx *pulumi.Context,
	name string, args *CustomerArgs, opts ...pulumi.ResourceOption) (*Customer, error)

NewCustomer registers a new resource with the given unique name, arguments, and options.

func (*Customer) ElementType

func (*Customer) ElementType() reflect.Type

func (*Customer) ToCustomerOutput

func (i *Customer) ToCustomerOutput() CustomerOutput

func (*Customer) ToCustomerOutputWithContext

func (i *Customer) ToCustomerOutputWithContext(ctx context.Context) CustomerOutput

type CustomerArgs

type CustomerArgs struct {
	// Map(String). The customer’s address, for all individual fields see: Address Fields.
	Address pulumi.StringMapInput
	// Int. Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.
	Balance pulumi.IntPtrInput
	// String. An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
	Description pulumi.StringPtrInput
	// String. Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
	Email pulumi.StringPtrInput
	// String. The prefix for the customer used to generate unique invoice numbers. Must be `3–12 uppercase letters or numbers`.
	InvoicePrefix pulumi.StringPtrInput
	// Map(String). Default invoice settings for this customer. For supported fields see: Invoice Settings Fields.
	InvoiceSettings pulumi.StringMapInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. The customer’s full name or business name.
	Name pulumi.StringPtrInput
	// Int. The sequence to be used on the customer’s next invoice. Defaults to 1.
	NextInvoiceSequence pulumi.IntPtrInput
	// String. The customer’s phone number.
	Phone pulumi.StringPtrInput
	// List(String). Customer’s preferred languages, ordered by preference.
	PreferredLocales pulumi.StringArrayInput
	// Map(String). Mailing and shipping address for the customer. Appears on invoices emailed to this customer. For all individual fields see: Shipping Fields.
	Shipping pulumi.StringMapInput
}

The set of arguments for constructing a Customer resource.

func (CustomerArgs) ElementType

func (CustomerArgs) ElementType() reflect.Type

type CustomerArray

type CustomerArray []CustomerInput

func (CustomerArray) ElementType

func (CustomerArray) ElementType() reflect.Type

func (CustomerArray) ToCustomerArrayOutput

func (i CustomerArray) ToCustomerArrayOutput() CustomerArrayOutput

func (CustomerArray) ToCustomerArrayOutputWithContext

func (i CustomerArray) ToCustomerArrayOutputWithContext(ctx context.Context) CustomerArrayOutput

type CustomerArrayInput

type CustomerArrayInput interface {
	pulumi.Input

	ToCustomerArrayOutput() CustomerArrayOutput
	ToCustomerArrayOutputWithContext(context.Context) CustomerArrayOutput
}

CustomerArrayInput is an input type that accepts CustomerArray and CustomerArrayOutput values. You can construct a concrete instance of `CustomerArrayInput` via:

CustomerArray{ CustomerArgs{...} }

type CustomerArrayOutput

type CustomerArrayOutput struct{ *pulumi.OutputState }

func (CustomerArrayOutput) ElementType

func (CustomerArrayOutput) ElementType() reflect.Type

func (CustomerArrayOutput) Index

func (CustomerArrayOutput) ToCustomerArrayOutput

func (o CustomerArrayOutput) ToCustomerArrayOutput() CustomerArrayOutput

func (CustomerArrayOutput) ToCustomerArrayOutputWithContext

func (o CustomerArrayOutput) ToCustomerArrayOutputWithContext(ctx context.Context) CustomerArrayOutput

type CustomerInput

type CustomerInput interface {
	pulumi.Input

	ToCustomerOutput() CustomerOutput
	ToCustomerOutputWithContext(ctx context.Context) CustomerOutput
}

type CustomerMap

type CustomerMap map[string]CustomerInput

func (CustomerMap) ElementType

func (CustomerMap) ElementType() reflect.Type

func (CustomerMap) ToCustomerMapOutput

func (i CustomerMap) ToCustomerMapOutput() CustomerMapOutput

func (CustomerMap) ToCustomerMapOutputWithContext

func (i CustomerMap) ToCustomerMapOutputWithContext(ctx context.Context) CustomerMapOutput

type CustomerMapInput

type CustomerMapInput interface {
	pulumi.Input

	ToCustomerMapOutput() CustomerMapOutput
	ToCustomerMapOutputWithContext(context.Context) CustomerMapOutput
}

CustomerMapInput is an input type that accepts CustomerMap and CustomerMapOutput values. You can construct a concrete instance of `CustomerMapInput` via:

CustomerMap{ "key": CustomerArgs{...} }

type CustomerMapOutput

type CustomerMapOutput struct{ *pulumi.OutputState }

func (CustomerMapOutput) ElementType

func (CustomerMapOutput) ElementType() reflect.Type

func (CustomerMapOutput) MapIndex

func (CustomerMapOutput) ToCustomerMapOutput

func (o CustomerMapOutput) ToCustomerMapOutput() CustomerMapOutput

func (CustomerMapOutput) ToCustomerMapOutputWithContext

func (o CustomerMapOutput) ToCustomerMapOutputWithContext(ctx context.Context) CustomerMapOutput

type CustomerOutput

type CustomerOutput struct{ *pulumi.OutputState }

func (CustomerOutput) Address

Map(String). The customer’s address, for all individual fields see: Address Fields.

func (CustomerOutput) Balance

func (o CustomerOutput) Balance() pulumi.IntPtrOutput

Int. Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.

func (CustomerOutput) DefaultInvoicePrefix

func (o CustomerOutput) DefaultInvoicePrefix() pulumi.StringOutput

String. The default invoice prefix generated by Stripe when not individual invoice prefix provided.

func (CustomerOutput) Description

func (o CustomerOutput) Description() pulumi.StringPtrOutput

String. An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.

func (CustomerOutput) ElementType

func (CustomerOutput) ElementType() reflect.Type

func (CustomerOutput) Email

String. Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.

func (CustomerOutput) InvoicePrefix

func (o CustomerOutput) InvoicePrefix() pulumi.StringPtrOutput

String. The prefix for the customer used to generate unique invoice numbers. Must be `3–12 uppercase letters or numbers`.

func (CustomerOutput) InvoiceSettings

func (o CustomerOutput) InvoiceSettings() pulumi.StringMapOutput

Map(String). Default invoice settings for this customer. For supported fields see: Invoice Settings Fields.

func (CustomerOutput) Metadata

func (o CustomerOutput) Metadata() pulumi.StringMapOutput

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

func (CustomerOutput) Name

String. The customer’s full name or business name.

func (CustomerOutput) NextInvoiceSequence

func (o CustomerOutput) NextInvoiceSequence() pulumi.IntPtrOutput

Int. The sequence to be used on the customer’s next invoice. Defaults to 1.

func (CustomerOutput) Phone

String. The customer’s phone number.

func (CustomerOutput) PreferredLocales

func (o CustomerOutput) PreferredLocales() pulumi.StringArrayOutput

List(String). Customer’s preferred languages, ordered by preference.

func (CustomerOutput) Shipping

func (o CustomerOutput) Shipping() pulumi.StringMapOutput

Map(String). Mailing and shipping address for the customer. Appears on invoices emailed to this customer. For all individual fields see: Shipping Fields.

func (CustomerOutput) ToCustomerOutput

func (o CustomerOutput) ToCustomerOutput() CustomerOutput

func (CustomerOutput) ToCustomerOutputWithContext

func (o CustomerOutput) ToCustomerOutputWithContext(ctx context.Context) CustomerOutput

type CustomerState

type CustomerState struct {
	// Map(String). The customer’s address, for all individual fields see: Address Fields.
	Address pulumi.StringMapInput
	// Int. Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.
	Balance pulumi.IntPtrInput
	// String. The default invoice prefix generated by Stripe when not individual invoice prefix provided.
	DefaultInvoicePrefix pulumi.StringPtrInput
	// String. An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
	Description pulumi.StringPtrInput
	// String. Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
	Email pulumi.StringPtrInput
	// String. The prefix for the customer used to generate unique invoice numbers. Must be `3–12 uppercase letters or numbers`.
	InvoicePrefix pulumi.StringPtrInput
	// Map(String). Default invoice settings for this customer. For supported fields see: Invoice Settings Fields.
	InvoiceSettings pulumi.StringMapInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. The customer’s full name or business name.
	Name pulumi.StringPtrInput
	// Int. The sequence to be used on the customer’s next invoice. Defaults to 1.
	NextInvoiceSequence pulumi.IntPtrInput
	// String. The customer’s phone number.
	Phone pulumi.StringPtrInput
	// List(String). Customer’s preferred languages, ordered by preference.
	PreferredLocales pulumi.StringArrayInput
	// Map(String). Mailing and shipping address for the customer. Appears on invoices emailed to this customer. For all individual fields see: Shipping Fields.
	Shipping pulumi.StringMapInput
}

func (CustomerState) ElementType

func (CustomerState) ElementType() reflect.Type

type PortalConfiguration

type PortalConfiguration struct {
	pulumi.CustomResourceState

	// Bool. Whether the configuration is active and can be used to create portal sessions. (On create it is always set as `true`)
	Active pulumi.BoolPtrOutput `pulumi:"active"`
	// List(Resource). The business information shown to customers in the portal. More details in Business Profile section
	BusinessProfile PortalConfigurationBusinessProfileOutput `pulumi:"businessProfile"`
	// String. The default URL to redirect customers to when they click on the portal’s link to return to your website. This can be overriden when creating the session.
	DefaultReturnUrl pulumi.StringPtrOutput `pulumi:"defaultReturnUrl"`
	// List(Resource). Information about the features available in the portal. Feature section described in Feature section
	Features PortalConfigurationFeaturesOutput `pulumi:"features"`
	// List(Resource). The hosted login page for this configuration. See details in Login Page Section.
	LoginPage PortalConfigurationLoginPageOutput `pulumi:"loginPage"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
}

With this resource, you can create a Customer Portal Configuration - [Stripe API portal configuration documentation](https://stripe.com/docs/api/customer_portal/configuration).

The Billing customer portal is a Stripe-hosted UI for subscription and billing management.

A portal configuration describes the functionality and features that you want to provide to your customers through the portal.

> Removal of the Customer Portal isn't supported through the Stripe SDK. The best practice, which this provider follows, is to deactivate the Customer Portal by marking it as inactive on destroy, which indicates that resource is no longer available.

## Example Usage

```go package main

import (

"github.com/georgegebbett/pulumi-stripe/sdk/go/stripe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stripe.NewPortalConfiguration(ctx, "portalConfiguration", &stripe.PortalConfigurationArgs{
			BusinessProfile: &stripe.PortalConfigurationBusinessProfileArgs{
				Headline:          pulumi.String("My special headline"),
				PrivacyPolicyUrl:  pulumi.String("https://example.com/privacy"),
				TermsOfServiceUrl: pulumi.String("https://example.com/terms"),
			},
			DefaultReturnUrl: pulumi.String("https://example.com/special_headline"),
			Features: &stripe.PortalConfigurationFeaturesArgs{
				CustomerUpdate: &stripe.PortalConfigurationFeaturesCustomerUpdateArgs{
					AllowedUpdates: pulumi.StringArray{
						pulumi.String("email"),
						pulumi.String("address"),
						pulumi.String("shipping"),
						pulumi.String("phone"),
						pulumi.String("tax_id"),
					},
					Enabled: pulumi.Bool(true),
				},
				InvoiceHistory: &stripe.PortalConfigurationFeaturesInvoiceHistoryArgs{
					Enabled: pulumi.Bool(true),
				},
				PaymentMethodUpdate: &stripe.PortalConfigurationFeaturesPaymentMethodUpdateArgs{
					Enabled: pulumi.Bool(true),
				},
				SubscriptionCancel: &stripe.PortalConfigurationFeaturesSubscriptionCancelArgs{
					CancellationReason: &stripe.PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs{
						Enabled: pulumi.Bool(true),
						Options: pulumi.StringArray{
							pulumi.String("too_expensive"),
							pulumi.String("missing_features"),
							pulumi.String("switched_service"),
							pulumi.String("unused"),
							pulumi.String("customer_service"),
							pulumi.String("too_complex"),
							pulumi.String("low_quality"),
							pulumi.String("other"),
						},
					},
					Enabled:           pulumi.Bool(true),
					Mode:              pulumi.String("at_period_end"),
					ProrationBehavior: pulumi.String("none"),
				},
				SubscriptionPauses: stripe.PortalConfigurationFeaturesSubscriptionPauseArray{
					&stripe.PortalConfigurationFeaturesSubscriptionPauseArgs{
						Enabled: pulumi.Bool(true),
					},
				},
				SubscriptionUpdates: stripe.PortalConfigurationFeaturesSubscriptionUpdateArray{
					&stripe.PortalConfigurationFeaturesSubscriptionUpdateArgs{
						DefaultAllowedUpdates: pulumi.StringArray{
							pulumi.String("price"),
							pulumi.String("quantity"),
							pulumi.String("promotion_code"),
						},
						Enabled: pulumi.Bool(true),
						Products: stripe.PortalConfigurationFeaturesSubscriptionUpdateProductArray{
							&stripe.PortalConfigurationFeaturesSubscriptionUpdateProductArgs{
								Prices: pulumi.StringArray{
									pulumi.String("my_price_id1"),
									pulumi.String("my_price_id2"),
								},
								Product: pulumi.String("my_product_id"),
							},
						},
						ProrationBehavior: pulumi.String("none"),
					},
				},
			},
			Metadata: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetPortalConfiguration

func GetPortalConfiguration(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PortalConfigurationState, opts ...pulumi.ResourceOption) (*PortalConfiguration, error)

GetPortalConfiguration gets an existing PortalConfiguration resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPortalConfiguration

func NewPortalConfiguration(ctx *pulumi.Context,
	name string, args *PortalConfigurationArgs, opts ...pulumi.ResourceOption) (*PortalConfiguration, error)

NewPortalConfiguration registers a new resource with the given unique name, arguments, and options.

func (*PortalConfiguration) ElementType

func (*PortalConfiguration) ElementType() reflect.Type

func (*PortalConfiguration) ToPortalConfigurationOutput

func (i *PortalConfiguration) ToPortalConfigurationOutput() PortalConfigurationOutput

func (*PortalConfiguration) ToPortalConfigurationOutputWithContext

func (i *PortalConfiguration) ToPortalConfigurationOutputWithContext(ctx context.Context) PortalConfigurationOutput

type PortalConfigurationArgs

type PortalConfigurationArgs struct {
	// Bool. Whether the configuration is active and can be used to create portal sessions. (On create it is always set as `true`)
	Active pulumi.BoolPtrInput
	// List(Resource). The business information shown to customers in the portal. More details in Business Profile section
	BusinessProfile PortalConfigurationBusinessProfileInput
	// String. The default URL to redirect customers to when they click on the portal’s link to return to your website. This can be overriden when creating the session.
	DefaultReturnUrl pulumi.StringPtrInput
	// List(Resource). Information about the features available in the portal. Feature section described in Feature section
	Features PortalConfigurationFeaturesInput
	// List(Resource). The hosted login page for this configuration. See details in Login Page Section.
	LoginPage PortalConfigurationLoginPagePtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
}

The set of arguments for constructing a PortalConfiguration resource.

func (PortalConfigurationArgs) ElementType

func (PortalConfigurationArgs) ElementType() reflect.Type

type PortalConfigurationArray

type PortalConfigurationArray []PortalConfigurationInput

func (PortalConfigurationArray) ElementType

func (PortalConfigurationArray) ElementType() reflect.Type

func (PortalConfigurationArray) ToPortalConfigurationArrayOutput

func (i PortalConfigurationArray) ToPortalConfigurationArrayOutput() PortalConfigurationArrayOutput

func (PortalConfigurationArray) ToPortalConfigurationArrayOutputWithContext

func (i PortalConfigurationArray) ToPortalConfigurationArrayOutputWithContext(ctx context.Context) PortalConfigurationArrayOutput

type PortalConfigurationArrayInput

type PortalConfigurationArrayInput interface {
	pulumi.Input

	ToPortalConfigurationArrayOutput() PortalConfigurationArrayOutput
	ToPortalConfigurationArrayOutputWithContext(context.Context) PortalConfigurationArrayOutput
}

PortalConfigurationArrayInput is an input type that accepts PortalConfigurationArray and PortalConfigurationArrayOutput values. You can construct a concrete instance of `PortalConfigurationArrayInput` via:

PortalConfigurationArray{ PortalConfigurationArgs{...} }

type PortalConfigurationArrayOutput

type PortalConfigurationArrayOutput struct{ *pulumi.OutputState }

func (PortalConfigurationArrayOutput) ElementType

func (PortalConfigurationArrayOutput) Index

func (PortalConfigurationArrayOutput) ToPortalConfigurationArrayOutput

func (o PortalConfigurationArrayOutput) ToPortalConfigurationArrayOutput() PortalConfigurationArrayOutput

func (PortalConfigurationArrayOutput) ToPortalConfigurationArrayOutputWithContext

func (o PortalConfigurationArrayOutput) ToPortalConfigurationArrayOutputWithContext(ctx context.Context) PortalConfigurationArrayOutput

type PortalConfigurationBusinessProfile

type PortalConfigurationBusinessProfile struct {
	// String. The messaging shown to customers in the portal.
	Headline *string `pulumi:"headline"`
	// String. A link to the business's publicly available privacy policy.
	PrivacyPolicyUrl *string `pulumi:"privacyPolicyUrl"`
	// String. A link to the business's publicly available terms of service.
	TermsOfServiceUrl *string `pulumi:"termsOfServiceUrl"`
}

type PortalConfigurationBusinessProfileArgs

type PortalConfigurationBusinessProfileArgs struct {
	// String. The messaging shown to customers in the portal.
	Headline pulumi.StringPtrInput `pulumi:"headline"`
	// String. A link to the business's publicly available privacy policy.
	PrivacyPolicyUrl pulumi.StringPtrInput `pulumi:"privacyPolicyUrl"`
	// String. A link to the business's publicly available terms of service.
	TermsOfServiceUrl pulumi.StringPtrInput `pulumi:"termsOfServiceUrl"`
}

func (PortalConfigurationBusinessProfileArgs) ElementType

func (PortalConfigurationBusinessProfileArgs) ToPortalConfigurationBusinessProfileOutput

func (i PortalConfigurationBusinessProfileArgs) ToPortalConfigurationBusinessProfileOutput() PortalConfigurationBusinessProfileOutput

func (PortalConfigurationBusinessProfileArgs) ToPortalConfigurationBusinessProfileOutputWithContext

func (i PortalConfigurationBusinessProfileArgs) ToPortalConfigurationBusinessProfileOutputWithContext(ctx context.Context) PortalConfigurationBusinessProfileOutput

func (PortalConfigurationBusinessProfileArgs) ToPortalConfigurationBusinessProfilePtrOutput

func (i PortalConfigurationBusinessProfileArgs) ToPortalConfigurationBusinessProfilePtrOutput() PortalConfigurationBusinessProfilePtrOutput

func (PortalConfigurationBusinessProfileArgs) ToPortalConfigurationBusinessProfilePtrOutputWithContext

func (i PortalConfigurationBusinessProfileArgs) ToPortalConfigurationBusinessProfilePtrOutputWithContext(ctx context.Context) PortalConfigurationBusinessProfilePtrOutput

type PortalConfigurationBusinessProfileInput

type PortalConfigurationBusinessProfileInput interface {
	pulumi.Input

	ToPortalConfigurationBusinessProfileOutput() PortalConfigurationBusinessProfileOutput
	ToPortalConfigurationBusinessProfileOutputWithContext(context.Context) PortalConfigurationBusinessProfileOutput
}

PortalConfigurationBusinessProfileInput is an input type that accepts PortalConfigurationBusinessProfileArgs and PortalConfigurationBusinessProfileOutput values. You can construct a concrete instance of `PortalConfigurationBusinessProfileInput` via:

PortalConfigurationBusinessProfileArgs{...}

type PortalConfigurationBusinessProfileOutput

type PortalConfigurationBusinessProfileOutput struct{ *pulumi.OutputState }

func (PortalConfigurationBusinessProfileOutput) ElementType

func (PortalConfigurationBusinessProfileOutput) Headline

String. The messaging shown to customers in the portal.

func (PortalConfigurationBusinessProfileOutput) PrivacyPolicyUrl

String. A link to the business's publicly available privacy policy.

func (PortalConfigurationBusinessProfileOutput) TermsOfServiceUrl

String. A link to the business's publicly available terms of service.

func (PortalConfigurationBusinessProfileOutput) ToPortalConfigurationBusinessProfileOutput

func (o PortalConfigurationBusinessProfileOutput) ToPortalConfigurationBusinessProfileOutput() PortalConfigurationBusinessProfileOutput

func (PortalConfigurationBusinessProfileOutput) ToPortalConfigurationBusinessProfileOutputWithContext

func (o PortalConfigurationBusinessProfileOutput) ToPortalConfigurationBusinessProfileOutputWithContext(ctx context.Context) PortalConfigurationBusinessProfileOutput

func (PortalConfigurationBusinessProfileOutput) ToPortalConfigurationBusinessProfilePtrOutput

func (o PortalConfigurationBusinessProfileOutput) ToPortalConfigurationBusinessProfilePtrOutput() PortalConfigurationBusinessProfilePtrOutput

func (PortalConfigurationBusinessProfileOutput) ToPortalConfigurationBusinessProfilePtrOutputWithContext

func (o PortalConfigurationBusinessProfileOutput) ToPortalConfigurationBusinessProfilePtrOutputWithContext(ctx context.Context) PortalConfigurationBusinessProfilePtrOutput

type PortalConfigurationBusinessProfilePtrInput

type PortalConfigurationBusinessProfilePtrInput interface {
	pulumi.Input

	ToPortalConfigurationBusinessProfilePtrOutput() PortalConfigurationBusinessProfilePtrOutput
	ToPortalConfigurationBusinessProfilePtrOutputWithContext(context.Context) PortalConfigurationBusinessProfilePtrOutput
}

PortalConfigurationBusinessProfilePtrInput is an input type that accepts PortalConfigurationBusinessProfileArgs, PortalConfigurationBusinessProfilePtr and PortalConfigurationBusinessProfilePtrOutput values. You can construct a concrete instance of `PortalConfigurationBusinessProfilePtrInput` via:

        PortalConfigurationBusinessProfileArgs{...}

or:

        nil

type PortalConfigurationBusinessProfilePtrOutput

type PortalConfigurationBusinessProfilePtrOutput struct{ *pulumi.OutputState }

func (PortalConfigurationBusinessProfilePtrOutput) Elem

func (PortalConfigurationBusinessProfilePtrOutput) ElementType

func (PortalConfigurationBusinessProfilePtrOutput) Headline

String. The messaging shown to customers in the portal.

func (PortalConfigurationBusinessProfilePtrOutput) PrivacyPolicyUrl

String. A link to the business's publicly available privacy policy.

func (PortalConfigurationBusinessProfilePtrOutput) TermsOfServiceUrl

String. A link to the business's publicly available terms of service.

func (PortalConfigurationBusinessProfilePtrOutput) ToPortalConfigurationBusinessProfilePtrOutput

func (o PortalConfigurationBusinessProfilePtrOutput) ToPortalConfigurationBusinessProfilePtrOutput() PortalConfigurationBusinessProfilePtrOutput

func (PortalConfigurationBusinessProfilePtrOutput) ToPortalConfigurationBusinessProfilePtrOutputWithContext

func (o PortalConfigurationBusinessProfilePtrOutput) ToPortalConfigurationBusinessProfilePtrOutputWithContext(ctx context.Context) PortalConfigurationBusinessProfilePtrOutput

type PortalConfigurationFeatures

type PortalConfigurationFeatures struct {
	// List(Resource). Information about updating the customer details in the portal. See Customer Update.
	CustomerUpdate *PortalConfigurationFeaturesCustomerUpdate `pulumi:"customerUpdate"`
	// List(Resource). Information about showing the billing history in the portal. See Invoice History.
	InvoiceHistory *PortalConfigurationFeaturesInvoiceHistory `pulumi:"invoiceHistory"`
	// List(Resource). Information about updating payment methods in the portal. See Payment Method Update.
	PaymentMethodUpdate *PortalConfigurationFeaturesPaymentMethodUpdate `pulumi:"paymentMethodUpdate"`
	// List(Resource). Information about canceling subscriptions in the portal. See Subscription Cancel.
	SubscriptionCancel *PortalConfigurationFeaturesSubscriptionCancel `pulumi:"subscriptionCancel"`
	// List(Resource). Information about pausing subscriptions in the portal. See Subscription Pause.
	SubscriptionPauses []PortalConfigurationFeaturesSubscriptionPause `pulumi:"subscriptionPauses"`
	// List(Resource). Information about updating subscriptions in the portal. See Subscription Update.
	SubscriptionUpdates []PortalConfigurationFeaturesSubscriptionUpdate `pulumi:"subscriptionUpdates"`
}

type PortalConfigurationFeaturesArgs

type PortalConfigurationFeaturesArgs struct {
	// List(Resource). Information about updating the customer details in the portal. See Customer Update.
	CustomerUpdate PortalConfigurationFeaturesCustomerUpdatePtrInput `pulumi:"customerUpdate"`
	// List(Resource). Information about showing the billing history in the portal. See Invoice History.
	InvoiceHistory PortalConfigurationFeaturesInvoiceHistoryPtrInput `pulumi:"invoiceHistory"`
	// List(Resource). Information about updating payment methods in the portal. See Payment Method Update.
	PaymentMethodUpdate PortalConfigurationFeaturesPaymentMethodUpdatePtrInput `pulumi:"paymentMethodUpdate"`
	// List(Resource). Information about canceling subscriptions in the portal. See Subscription Cancel.
	SubscriptionCancel PortalConfigurationFeaturesSubscriptionCancelPtrInput `pulumi:"subscriptionCancel"`
	// List(Resource). Information about pausing subscriptions in the portal. See Subscription Pause.
	SubscriptionPauses PortalConfigurationFeaturesSubscriptionPauseArrayInput `pulumi:"subscriptionPauses"`
	// List(Resource). Information about updating subscriptions in the portal. See Subscription Update.
	SubscriptionUpdates PortalConfigurationFeaturesSubscriptionUpdateArrayInput `pulumi:"subscriptionUpdates"`
}

func (PortalConfigurationFeaturesArgs) ElementType

func (PortalConfigurationFeaturesArgs) ToPortalConfigurationFeaturesOutput

func (i PortalConfigurationFeaturesArgs) ToPortalConfigurationFeaturesOutput() PortalConfigurationFeaturesOutput

func (PortalConfigurationFeaturesArgs) ToPortalConfigurationFeaturesOutputWithContext

func (i PortalConfigurationFeaturesArgs) ToPortalConfigurationFeaturesOutputWithContext(ctx context.Context) PortalConfigurationFeaturesOutput

func (PortalConfigurationFeaturesArgs) ToPortalConfigurationFeaturesPtrOutput

func (i PortalConfigurationFeaturesArgs) ToPortalConfigurationFeaturesPtrOutput() PortalConfigurationFeaturesPtrOutput

func (PortalConfigurationFeaturesArgs) ToPortalConfigurationFeaturesPtrOutputWithContext

func (i PortalConfigurationFeaturesArgs) ToPortalConfigurationFeaturesPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesPtrOutput

type PortalConfigurationFeaturesCustomerUpdate

type PortalConfigurationFeaturesCustomerUpdate struct {
	// List(String). The types of customer updates that are supported [`name`, `email`, `address`, `shipping`, `phone`, `taxId`]. When empty, customers are not updatable.
	AllowedUpdates []string `pulumi:"allowedUpdates"`
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled bool `pulumi:"enabled"`
}

type PortalConfigurationFeaturesCustomerUpdateArgs

type PortalConfigurationFeaturesCustomerUpdateArgs struct {
	// List(String). The types of customer updates that are supported [`name`, `email`, `address`, `shipping`, `phone`, `taxId`]. When empty, customers are not updatable.
	AllowedUpdates pulumi.StringArrayInput `pulumi:"allowedUpdates"`
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
}

func (PortalConfigurationFeaturesCustomerUpdateArgs) ElementType

func (PortalConfigurationFeaturesCustomerUpdateArgs) ToPortalConfigurationFeaturesCustomerUpdateOutput

func (i PortalConfigurationFeaturesCustomerUpdateArgs) ToPortalConfigurationFeaturesCustomerUpdateOutput() PortalConfigurationFeaturesCustomerUpdateOutput

func (PortalConfigurationFeaturesCustomerUpdateArgs) ToPortalConfigurationFeaturesCustomerUpdateOutputWithContext

func (i PortalConfigurationFeaturesCustomerUpdateArgs) ToPortalConfigurationFeaturesCustomerUpdateOutputWithContext(ctx context.Context) PortalConfigurationFeaturesCustomerUpdateOutput

func (PortalConfigurationFeaturesCustomerUpdateArgs) ToPortalConfigurationFeaturesCustomerUpdatePtrOutput

func (i PortalConfigurationFeaturesCustomerUpdateArgs) ToPortalConfigurationFeaturesCustomerUpdatePtrOutput() PortalConfigurationFeaturesCustomerUpdatePtrOutput

func (PortalConfigurationFeaturesCustomerUpdateArgs) ToPortalConfigurationFeaturesCustomerUpdatePtrOutputWithContext

func (i PortalConfigurationFeaturesCustomerUpdateArgs) ToPortalConfigurationFeaturesCustomerUpdatePtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesCustomerUpdatePtrOutput

type PortalConfigurationFeaturesCustomerUpdateInput

type PortalConfigurationFeaturesCustomerUpdateInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesCustomerUpdateOutput() PortalConfigurationFeaturesCustomerUpdateOutput
	ToPortalConfigurationFeaturesCustomerUpdateOutputWithContext(context.Context) PortalConfigurationFeaturesCustomerUpdateOutput
}

PortalConfigurationFeaturesCustomerUpdateInput is an input type that accepts PortalConfigurationFeaturesCustomerUpdateArgs and PortalConfigurationFeaturesCustomerUpdateOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesCustomerUpdateInput` via:

PortalConfigurationFeaturesCustomerUpdateArgs{...}

type PortalConfigurationFeaturesCustomerUpdateOutput

type PortalConfigurationFeaturesCustomerUpdateOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesCustomerUpdateOutput) AllowedUpdates

List(String). The types of customer updates that are supported [`name`, `email`, `address`, `shipping`, `phone`, `taxId`]. When empty, customers are not updatable.

func (PortalConfigurationFeaturesCustomerUpdateOutput) ElementType

func (PortalConfigurationFeaturesCustomerUpdateOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesCustomerUpdateOutput) ToPortalConfigurationFeaturesCustomerUpdateOutput

func (o PortalConfigurationFeaturesCustomerUpdateOutput) ToPortalConfigurationFeaturesCustomerUpdateOutput() PortalConfigurationFeaturesCustomerUpdateOutput

func (PortalConfigurationFeaturesCustomerUpdateOutput) ToPortalConfigurationFeaturesCustomerUpdateOutputWithContext

func (o PortalConfigurationFeaturesCustomerUpdateOutput) ToPortalConfigurationFeaturesCustomerUpdateOutputWithContext(ctx context.Context) PortalConfigurationFeaturesCustomerUpdateOutput

func (PortalConfigurationFeaturesCustomerUpdateOutput) ToPortalConfigurationFeaturesCustomerUpdatePtrOutput

func (o PortalConfigurationFeaturesCustomerUpdateOutput) ToPortalConfigurationFeaturesCustomerUpdatePtrOutput() PortalConfigurationFeaturesCustomerUpdatePtrOutput

func (PortalConfigurationFeaturesCustomerUpdateOutput) ToPortalConfigurationFeaturesCustomerUpdatePtrOutputWithContext

func (o PortalConfigurationFeaturesCustomerUpdateOutput) ToPortalConfigurationFeaturesCustomerUpdatePtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesCustomerUpdatePtrOutput

type PortalConfigurationFeaturesCustomerUpdatePtrInput

type PortalConfigurationFeaturesCustomerUpdatePtrInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesCustomerUpdatePtrOutput() PortalConfigurationFeaturesCustomerUpdatePtrOutput
	ToPortalConfigurationFeaturesCustomerUpdatePtrOutputWithContext(context.Context) PortalConfigurationFeaturesCustomerUpdatePtrOutput
}

PortalConfigurationFeaturesCustomerUpdatePtrInput is an input type that accepts PortalConfigurationFeaturesCustomerUpdateArgs, PortalConfigurationFeaturesCustomerUpdatePtr and PortalConfigurationFeaturesCustomerUpdatePtrOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesCustomerUpdatePtrInput` via:

        PortalConfigurationFeaturesCustomerUpdateArgs{...}

or:

        nil

type PortalConfigurationFeaturesCustomerUpdatePtrOutput

type PortalConfigurationFeaturesCustomerUpdatePtrOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesCustomerUpdatePtrOutput) AllowedUpdates

List(String). The types of customer updates that are supported [`name`, `email`, `address`, `shipping`, `phone`, `taxId`]. When empty, customers are not updatable.

func (PortalConfigurationFeaturesCustomerUpdatePtrOutput) Elem

func (PortalConfigurationFeaturesCustomerUpdatePtrOutput) ElementType

func (PortalConfigurationFeaturesCustomerUpdatePtrOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesCustomerUpdatePtrOutput) ToPortalConfigurationFeaturesCustomerUpdatePtrOutput

func (o PortalConfigurationFeaturesCustomerUpdatePtrOutput) ToPortalConfigurationFeaturesCustomerUpdatePtrOutput() PortalConfigurationFeaturesCustomerUpdatePtrOutput

func (PortalConfigurationFeaturesCustomerUpdatePtrOutput) ToPortalConfigurationFeaturesCustomerUpdatePtrOutputWithContext

func (o PortalConfigurationFeaturesCustomerUpdatePtrOutput) ToPortalConfigurationFeaturesCustomerUpdatePtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesCustomerUpdatePtrOutput

type PortalConfigurationFeaturesInput

type PortalConfigurationFeaturesInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesOutput() PortalConfigurationFeaturesOutput
	ToPortalConfigurationFeaturesOutputWithContext(context.Context) PortalConfigurationFeaturesOutput
}

PortalConfigurationFeaturesInput is an input type that accepts PortalConfigurationFeaturesArgs and PortalConfigurationFeaturesOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesInput` via:

PortalConfigurationFeaturesArgs{...}

type PortalConfigurationFeaturesInvoiceHistory

type PortalConfigurationFeaturesInvoiceHistory struct {
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled bool `pulumi:"enabled"`
}

type PortalConfigurationFeaturesInvoiceHistoryArgs

type PortalConfigurationFeaturesInvoiceHistoryArgs struct {
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
}

func (PortalConfigurationFeaturesInvoiceHistoryArgs) ElementType

func (PortalConfigurationFeaturesInvoiceHistoryArgs) ToPortalConfigurationFeaturesInvoiceHistoryOutput

func (i PortalConfigurationFeaturesInvoiceHistoryArgs) ToPortalConfigurationFeaturesInvoiceHistoryOutput() PortalConfigurationFeaturesInvoiceHistoryOutput

func (PortalConfigurationFeaturesInvoiceHistoryArgs) ToPortalConfigurationFeaturesInvoiceHistoryOutputWithContext

func (i PortalConfigurationFeaturesInvoiceHistoryArgs) ToPortalConfigurationFeaturesInvoiceHistoryOutputWithContext(ctx context.Context) PortalConfigurationFeaturesInvoiceHistoryOutput

func (PortalConfigurationFeaturesInvoiceHistoryArgs) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutput

func (i PortalConfigurationFeaturesInvoiceHistoryArgs) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutput() PortalConfigurationFeaturesInvoiceHistoryPtrOutput

func (PortalConfigurationFeaturesInvoiceHistoryArgs) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutputWithContext

func (i PortalConfigurationFeaturesInvoiceHistoryArgs) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesInvoiceHistoryPtrOutput

type PortalConfigurationFeaturesInvoiceHistoryInput

type PortalConfigurationFeaturesInvoiceHistoryInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesInvoiceHistoryOutput() PortalConfigurationFeaturesInvoiceHistoryOutput
	ToPortalConfigurationFeaturesInvoiceHistoryOutputWithContext(context.Context) PortalConfigurationFeaturesInvoiceHistoryOutput
}

PortalConfigurationFeaturesInvoiceHistoryInput is an input type that accepts PortalConfigurationFeaturesInvoiceHistoryArgs and PortalConfigurationFeaturesInvoiceHistoryOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesInvoiceHistoryInput` via:

PortalConfigurationFeaturesInvoiceHistoryArgs{...}

type PortalConfigurationFeaturesInvoiceHistoryOutput

type PortalConfigurationFeaturesInvoiceHistoryOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesInvoiceHistoryOutput) ElementType

func (PortalConfigurationFeaturesInvoiceHistoryOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesInvoiceHistoryOutput) ToPortalConfigurationFeaturesInvoiceHistoryOutput

func (o PortalConfigurationFeaturesInvoiceHistoryOutput) ToPortalConfigurationFeaturesInvoiceHistoryOutput() PortalConfigurationFeaturesInvoiceHistoryOutput

func (PortalConfigurationFeaturesInvoiceHistoryOutput) ToPortalConfigurationFeaturesInvoiceHistoryOutputWithContext

func (o PortalConfigurationFeaturesInvoiceHistoryOutput) ToPortalConfigurationFeaturesInvoiceHistoryOutputWithContext(ctx context.Context) PortalConfigurationFeaturesInvoiceHistoryOutput

func (PortalConfigurationFeaturesInvoiceHistoryOutput) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutput

func (o PortalConfigurationFeaturesInvoiceHistoryOutput) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutput() PortalConfigurationFeaturesInvoiceHistoryPtrOutput

func (PortalConfigurationFeaturesInvoiceHistoryOutput) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutputWithContext

func (o PortalConfigurationFeaturesInvoiceHistoryOutput) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesInvoiceHistoryPtrOutput

type PortalConfigurationFeaturesInvoiceHistoryPtrInput

type PortalConfigurationFeaturesInvoiceHistoryPtrInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesInvoiceHistoryPtrOutput() PortalConfigurationFeaturesInvoiceHistoryPtrOutput
	ToPortalConfigurationFeaturesInvoiceHistoryPtrOutputWithContext(context.Context) PortalConfigurationFeaturesInvoiceHistoryPtrOutput
}

PortalConfigurationFeaturesInvoiceHistoryPtrInput is an input type that accepts PortalConfigurationFeaturesInvoiceHistoryArgs, PortalConfigurationFeaturesInvoiceHistoryPtr and PortalConfigurationFeaturesInvoiceHistoryPtrOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesInvoiceHistoryPtrInput` via:

        PortalConfigurationFeaturesInvoiceHistoryArgs{...}

or:

        nil

type PortalConfigurationFeaturesInvoiceHistoryPtrOutput

type PortalConfigurationFeaturesInvoiceHistoryPtrOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesInvoiceHistoryPtrOutput) Elem

func (PortalConfigurationFeaturesInvoiceHistoryPtrOutput) ElementType

func (PortalConfigurationFeaturesInvoiceHistoryPtrOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesInvoiceHistoryPtrOutput) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutput

func (o PortalConfigurationFeaturesInvoiceHistoryPtrOutput) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutput() PortalConfigurationFeaturesInvoiceHistoryPtrOutput

func (PortalConfigurationFeaturesInvoiceHistoryPtrOutput) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutputWithContext

func (o PortalConfigurationFeaturesInvoiceHistoryPtrOutput) ToPortalConfigurationFeaturesInvoiceHistoryPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesInvoiceHistoryPtrOutput

type PortalConfigurationFeaturesOutput

type PortalConfigurationFeaturesOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesOutput) CustomerUpdate

List(Resource). Information about updating the customer details in the portal. See Customer Update.

func (PortalConfigurationFeaturesOutput) ElementType

func (PortalConfigurationFeaturesOutput) InvoiceHistory

List(Resource). Information about showing the billing history in the portal. See Invoice History.

func (PortalConfigurationFeaturesOutput) PaymentMethodUpdate

List(Resource). Information about updating payment methods in the portal. See Payment Method Update.

func (PortalConfigurationFeaturesOutput) SubscriptionCancel

List(Resource). Information about canceling subscriptions in the portal. See Subscription Cancel.

func (PortalConfigurationFeaturesOutput) SubscriptionPauses

List(Resource). Information about pausing subscriptions in the portal. See Subscription Pause.

func (PortalConfigurationFeaturesOutput) SubscriptionUpdates

List(Resource). Information about updating subscriptions in the portal. See Subscription Update.

func (PortalConfigurationFeaturesOutput) ToPortalConfigurationFeaturesOutput

func (o PortalConfigurationFeaturesOutput) ToPortalConfigurationFeaturesOutput() PortalConfigurationFeaturesOutput

func (PortalConfigurationFeaturesOutput) ToPortalConfigurationFeaturesOutputWithContext

func (o PortalConfigurationFeaturesOutput) ToPortalConfigurationFeaturesOutputWithContext(ctx context.Context) PortalConfigurationFeaturesOutput

func (PortalConfigurationFeaturesOutput) ToPortalConfigurationFeaturesPtrOutput

func (o PortalConfigurationFeaturesOutput) ToPortalConfigurationFeaturesPtrOutput() PortalConfigurationFeaturesPtrOutput

func (PortalConfigurationFeaturesOutput) ToPortalConfigurationFeaturesPtrOutputWithContext

func (o PortalConfigurationFeaturesOutput) ToPortalConfigurationFeaturesPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesPtrOutput

type PortalConfigurationFeaturesPaymentMethodUpdate

type PortalConfigurationFeaturesPaymentMethodUpdate struct {
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled bool `pulumi:"enabled"`
}

type PortalConfigurationFeaturesPaymentMethodUpdateArgs

type PortalConfigurationFeaturesPaymentMethodUpdateArgs struct {
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
}

func (PortalConfigurationFeaturesPaymentMethodUpdateArgs) ElementType

func (PortalConfigurationFeaturesPaymentMethodUpdateArgs) ToPortalConfigurationFeaturesPaymentMethodUpdateOutput

func (i PortalConfigurationFeaturesPaymentMethodUpdateArgs) ToPortalConfigurationFeaturesPaymentMethodUpdateOutput() PortalConfigurationFeaturesPaymentMethodUpdateOutput

func (PortalConfigurationFeaturesPaymentMethodUpdateArgs) ToPortalConfigurationFeaturesPaymentMethodUpdateOutputWithContext

func (i PortalConfigurationFeaturesPaymentMethodUpdateArgs) ToPortalConfigurationFeaturesPaymentMethodUpdateOutputWithContext(ctx context.Context) PortalConfigurationFeaturesPaymentMethodUpdateOutput

func (PortalConfigurationFeaturesPaymentMethodUpdateArgs) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

func (i PortalConfigurationFeaturesPaymentMethodUpdateArgs) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutput() PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

func (PortalConfigurationFeaturesPaymentMethodUpdateArgs) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutputWithContext

func (i PortalConfigurationFeaturesPaymentMethodUpdateArgs) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

type PortalConfigurationFeaturesPaymentMethodUpdateInput

type PortalConfigurationFeaturesPaymentMethodUpdateInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesPaymentMethodUpdateOutput() PortalConfigurationFeaturesPaymentMethodUpdateOutput
	ToPortalConfigurationFeaturesPaymentMethodUpdateOutputWithContext(context.Context) PortalConfigurationFeaturesPaymentMethodUpdateOutput
}

PortalConfigurationFeaturesPaymentMethodUpdateInput is an input type that accepts PortalConfigurationFeaturesPaymentMethodUpdateArgs and PortalConfigurationFeaturesPaymentMethodUpdateOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesPaymentMethodUpdateInput` via:

PortalConfigurationFeaturesPaymentMethodUpdateArgs{...}

type PortalConfigurationFeaturesPaymentMethodUpdateOutput

type PortalConfigurationFeaturesPaymentMethodUpdateOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesPaymentMethodUpdateOutput) ElementType

func (PortalConfigurationFeaturesPaymentMethodUpdateOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesPaymentMethodUpdateOutput) ToPortalConfigurationFeaturesPaymentMethodUpdateOutput

func (PortalConfigurationFeaturesPaymentMethodUpdateOutput) ToPortalConfigurationFeaturesPaymentMethodUpdateOutputWithContext

func (o PortalConfigurationFeaturesPaymentMethodUpdateOutput) ToPortalConfigurationFeaturesPaymentMethodUpdateOutputWithContext(ctx context.Context) PortalConfigurationFeaturesPaymentMethodUpdateOutput

func (PortalConfigurationFeaturesPaymentMethodUpdateOutput) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

func (o PortalConfigurationFeaturesPaymentMethodUpdateOutput) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutput() PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

func (PortalConfigurationFeaturesPaymentMethodUpdateOutput) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutputWithContext

func (o PortalConfigurationFeaturesPaymentMethodUpdateOutput) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

type PortalConfigurationFeaturesPaymentMethodUpdatePtrInput

type PortalConfigurationFeaturesPaymentMethodUpdatePtrInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutput() PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput
	ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutputWithContext(context.Context) PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput
}

PortalConfigurationFeaturesPaymentMethodUpdatePtrInput is an input type that accepts PortalConfigurationFeaturesPaymentMethodUpdateArgs, PortalConfigurationFeaturesPaymentMethodUpdatePtr and PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesPaymentMethodUpdatePtrInput` via:

        PortalConfigurationFeaturesPaymentMethodUpdateArgs{...}

or:

        nil

type PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

type PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput) Elem

func (PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput) ElementType

func (PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

func (PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutputWithContext

func (o PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput) ToPortalConfigurationFeaturesPaymentMethodUpdatePtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesPaymentMethodUpdatePtrOutput

type PortalConfigurationFeaturesPtrInput

type PortalConfigurationFeaturesPtrInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesPtrOutput() PortalConfigurationFeaturesPtrOutput
	ToPortalConfigurationFeaturesPtrOutputWithContext(context.Context) PortalConfigurationFeaturesPtrOutput
}

PortalConfigurationFeaturesPtrInput is an input type that accepts PortalConfigurationFeaturesArgs, PortalConfigurationFeaturesPtr and PortalConfigurationFeaturesPtrOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesPtrInput` via:

        PortalConfigurationFeaturesArgs{...}

or:

        nil

type PortalConfigurationFeaturesPtrOutput

type PortalConfigurationFeaturesPtrOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesPtrOutput) CustomerUpdate

List(Resource). Information about updating the customer details in the portal. See Customer Update.

func (PortalConfigurationFeaturesPtrOutput) Elem

func (PortalConfigurationFeaturesPtrOutput) ElementType

func (PortalConfigurationFeaturesPtrOutput) InvoiceHistory

List(Resource). Information about showing the billing history in the portal. See Invoice History.

func (PortalConfigurationFeaturesPtrOutput) PaymentMethodUpdate

List(Resource). Information about updating payment methods in the portal. See Payment Method Update.

func (PortalConfigurationFeaturesPtrOutput) SubscriptionCancel

List(Resource). Information about canceling subscriptions in the portal. See Subscription Cancel.

func (PortalConfigurationFeaturesPtrOutput) SubscriptionPauses

List(Resource). Information about pausing subscriptions in the portal. See Subscription Pause.

func (PortalConfigurationFeaturesPtrOutput) SubscriptionUpdates

List(Resource). Information about updating subscriptions in the portal. See Subscription Update.

func (PortalConfigurationFeaturesPtrOutput) ToPortalConfigurationFeaturesPtrOutput

func (o PortalConfigurationFeaturesPtrOutput) ToPortalConfigurationFeaturesPtrOutput() PortalConfigurationFeaturesPtrOutput

func (PortalConfigurationFeaturesPtrOutput) ToPortalConfigurationFeaturesPtrOutputWithContext

func (o PortalConfigurationFeaturesPtrOutput) ToPortalConfigurationFeaturesPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesPtrOutput

type PortalConfigurationFeaturesSubscriptionCancel

type PortalConfigurationFeaturesSubscriptionCancel struct {
	// List(Resource). Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer. Details of this field is in Cancellation Reason.
	CancellationReason *PortalConfigurationFeaturesSubscriptionCancelCancellationReason `pulumi:"cancellationReason"`
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled bool `pulumi:"enabled"`
	// String. Whether to cancel subscriptions immediately or at the end of the billing period. Valid value is either `immediately` or `atPeriodEnd`
	Mode *string `pulumi:"mode"`
	// String. Whether to create prorations when canceling subscriptions. Possible values are `none` and `createProrations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.
	ProrationBehavior *string `pulumi:"prorationBehavior"`
}

type PortalConfigurationFeaturesSubscriptionCancelArgs

type PortalConfigurationFeaturesSubscriptionCancelArgs struct {
	// List(Resource). Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer. Details of this field is in Cancellation Reason.
	CancellationReason PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrInput `pulumi:"cancellationReason"`
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// String. Whether to cancel subscriptions immediately or at the end of the billing period. Valid value is either `immediately` or `atPeriodEnd`
	Mode pulumi.StringPtrInput `pulumi:"mode"`
	// String. Whether to create prorations when canceling subscriptions. Possible values are `none` and `createProrations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.
	ProrationBehavior pulumi.StringPtrInput `pulumi:"prorationBehavior"`
}

func (PortalConfigurationFeaturesSubscriptionCancelArgs) ElementType

func (PortalConfigurationFeaturesSubscriptionCancelArgs) ToPortalConfigurationFeaturesSubscriptionCancelOutput

func (i PortalConfigurationFeaturesSubscriptionCancelArgs) ToPortalConfigurationFeaturesSubscriptionCancelOutput() PortalConfigurationFeaturesSubscriptionCancelOutput

func (PortalConfigurationFeaturesSubscriptionCancelArgs) ToPortalConfigurationFeaturesSubscriptionCancelOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionCancelArgs) ToPortalConfigurationFeaturesSubscriptionCancelOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelOutput

func (PortalConfigurationFeaturesSubscriptionCancelArgs) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutput

func (i PortalConfigurationFeaturesSubscriptionCancelArgs) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutput() PortalConfigurationFeaturesSubscriptionCancelPtrOutput

func (PortalConfigurationFeaturesSubscriptionCancelArgs) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionCancelArgs) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelPtrOutput

type PortalConfigurationFeaturesSubscriptionCancelCancellationReason

type PortalConfigurationFeaturesSubscriptionCancelCancellationReason struct {
	// Bool. Whether the feature is enabled.
	Enabled bool `pulumi:"enabled"`
	// List(String). Which cancellation reasons will be given as options to the customer. Supported values are `tooExpensive`, `missingFeatures`, `switchedService`, `unused`, `customerService`, `tooComplex`, `lowQuality`, and `other`.
	Options []string `pulumi:"options"`
}

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs struct {
	// Bool. Whether the feature is enabled.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// List(String). Which cancellation reasons will be given as options to the customer. Supported values are `tooExpensive`, `missingFeatures`, `switchedService`, `unused`, `customerService`, `tooComplex`, `lowQuality`, and `other`.
	Options pulumi.StringArrayInput `pulumi:"options"`
}

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs) ElementType

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonInput

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput() PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput
	ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput
}

PortalConfigurationFeaturesSubscriptionCancelCancellationReasonInput is an input type that accepts PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs and PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionCancelCancellationReasonInput` via:

PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs{...}

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) Enabled

Bool. Whether the feature is enabled.

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) Options

List(String). Which cancellation reasons will be given as options to the customer. Supported values are `tooExpensive`, `missingFeatures`, `switchedService`, `unused`, `customerService`, `tooComplex`, `lowQuality`, and `other`.

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionCancelCancellationReasonOutput) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrInput

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput() PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput
	ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput
}

PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrInput is an input type that accepts PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs, PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtr and PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrInput` via:

        PortalConfigurationFeaturesSubscriptionCancelCancellationReasonArgs{...}

or:

        nil

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput

type PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput) Elem

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput) Enabled

Bool. Whether the feature is enabled.

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput) Options

List(String). Which cancellation reasons will be given as options to the customer. Supported values are `tooExpensive`, `missingFeatures`, `switchedService`, `unused`, `customerService`, `tooComplex`, `lowQuality`, and `other`.

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput

func (PortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutput) ToPortalConfigurationFeaturesSubscriptionCancelCancellationReasonPtrOutputWithContext

type PortalConfigurationFeaturesSubscriptionCancelInput

type PortalConfigurationFeaturesSubscriptionCancelInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionCancelOutput() PortalConfigurationFeaturesSubscriptionCancelOutput
	ToPortalConfigurationFeaturesSubscriptionCancelOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionCancelOutput
}

PortalConfigurationFeaturesSubscriptionCancelInput is an input type that accepts PortalConfigurationFeaturesSubscriptionCancelArgs and PortalConfigurationFeaturesSubscriptionCancelOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionCancelInput` via:

PortalConfigurationFeaturesSubscriptionCancelArgs{...}

type PortalConfigurationFeaturesSubscriptionCancelOutput

type PortalConfigurationFeaturesSubscriptionCancelOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionCancelOutput) CancellationReason

List(Resource). Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer. Details of this field is in Cancellation Reason.

func (PortalConfigurationFeaturesSubscriptionCancelOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionCancelOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesSubscriptionCancelOutput) Mode

String. Whether to cancel subscriptions immediately or at the end of the billing period. Valid value is either `immediately` or `atPeriodEnd`

func (PortalConfigurationFeaturesSubscriptionCancelOutput) ProrationBehavior

String. Whether to create prorations when canceling subscriptions. Possible values are `none` and `createProrations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.

func (PortalConfigurationFeaturesSubscriptionCancelOutput) ToPortalConfigurationFeaturesSubscriptionCancelOutput

func (o PortalConfigurationFeaturesSubscriptionCancelOutput) ToPortalConfigurationFeaturesSubscriptionCancelOutput() PortalConfigurationFeaturesSubscriptionCancelOutput

func (PortalConfigurationFeaturesSubscriptionCancelOutput) ToPortalConfigurationFeaturesSubscriptionCancelOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionCancelOutput) ToPortalConfigurationFeaturesSubscriptionCancelOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelOutput

func (PortalConfigurationFeaturesSubscriptionCancelOutput) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutput

func (o PortalConfigurationFeaturesSubscriptionCancelOutput) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutput() PortalConfigurationFeaturesSubscriptionCancelPtrOutput

func (PortalConfigurationFeaturesSubscriptionCancelOutput) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionCancelOutput) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelPtrOutput

type PortalConfigurationFeaturesSubscriptionCancelPtrInput

type PortalConfigurationFeaturesSubscriptionCancelPtrInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionCancelPtrOutput() PortalConfigurationFeaturesSubscriptionCancelPtrOutput
	ToPortalConfigurationFeaturesSubscriptionCancelPtrOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionCancelPtrOutput
}

PortalConfigurationFeaturesSubscriptionCancelPtrInput is an input type that accepts PortalConfigurationFeaturesSubscriptionCancelArgs, PortalConfigurationFeaturesSubscriptionCancelPtr and PortalConfigurationFeaturesSubscriptionCancelPtrOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionCancelPtrInput` via:

        PortalConfigurationFeaturesSubscriptionCancelArgs{...}

or:

        nil

type PortalConfigurationFeaturesSubscriptionCancelPtrOutput

type PortalConfigurationFeaturesSubscriptionCancelPtrOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionCancelPtrOutput) CancellationReason

List(Resource). Whether the cancellation reasons will be collected in the portal and which options are exposed to the customer. Details of this field is in Cancellation Reason.

func (PortalConfigurationFeaturesSubscriptionCancelPtrOutput) Elem

func (PortalConfigurationFeaturesSubscriptionCancelPtrOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionCancelPtrOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesSubscriptionCancelPtrOutput) Mode

String. Whether to cancel subscriptions immediately or at the end of the billing period. Valid value is either `immediately` or `atPeriodEnd`

func (PortalConfigurationFeaturesSubscriptionCancelPtrOutput) ProrationBehavior

String. Whether to create prorations when canceling subscriptions. Possible values are `none` and `createProrations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.

func (PortalConfigurationFeaturesSubscriptionCancelPtrOutput) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutput

func (PortalConfigurationFeaturesSubscriptionCancelPtrOutput) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionCancelPtrOutput) ToPortalConfigurationFeaturesSubscriptionCancelPtrOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionCancelPtrOutput

type PortalConfigurationFeaturesSubscriptionPause

type PortalConfigurationFeaturesSubscriptionPause struct {
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled *bool `pulumi:"enabled"`
}

type PortalConfigurationFeaturesSubscriptionPauseArgs

type PortalConfigurationFeaturesSubscriptionPauseArgs struct {
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
}

func (PortalConfigurationFeaturesSubscriptionPauseArgs) ElementType

func (PortalConfigurationFeaturesSubscriptionPauseArgs) ToPortalConfigurationFeaturesSubscriptionPauseOutput

func (i PortalConfigurationFeaturesSubscriptionPauseArgs) ToPortalConfigurationFeaturesSubscriptionPauseOutput() PortalConfigurationFeaturesSubscriptionPauseOutput

func (PortalConfigurationFeaturesSubscriptionPauseArgs) ToPortalConfigurationFeaturesSubscriptionPauseOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionPauseArgs) ToPortalConfigurationFeaturesSubscriptionPauseOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionPauseOutput

type PortalConfigurationFeaturesSubscriptionPauseArray

type PortalConfigurationFeaturesSubscriptionPauseArray []PortalConfigurationFeaturesSubscriptionPauseInput

func (PortalConfigurationFeaturesSubscriptionPauseArray) ElementType

func (PortalConfigurationFeaturesSubscriptionPauseArray) ToPortalConfigurationFeaturesSubscriptionPauseArrayOutput

func (i PortalConfigurationFeaturesSubscriptionPauseArray) ToPortalConfigurationFeaturesSubscriptionPauseArrayOutput() PortalConfigurationFeaturesSubscriptionPauseArrayOutput

func (PortalConfigurationFeaturesSubscriptionPauseArray) ToPortalConfigurationFeaturesSubscriptionPauseArrayOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionPauseArray) ToPortalConfigurationFeaturesSubscriptionPauseArrayOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionPauseArrayOutput

type PortalConfigurationFeaturesSubscriptionPauseArrayInput

type PortalConfigurationFeaturesSubscriptionPauseArrayInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionPauseArrayOutput() PortalConfigurationFeaturesSubscriptionPauseArrayOutput
	ToPortalConfigurationFeaturesSubscriptionPauseArrayOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionPauseArrayOutput
}

PortalConfigurationFeaturesSubscriptionPauseArrayInput is an input type that accepts PortalConfigurationFeaturesSubscriptionPauseArray and PortalConfigurationFeaturesSubscriptionPauseArrayOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionPauseArrayInput` via:

PortalConfigurationFeaturesSubscriptionPauseArray{ PortalConfigurationFeaturesSubscriptionPauseArgs{...} }

type PortalConfigurationFeaturesSubscriptionPauseArrayOutput

type PortalConfigurationFeaturesSubscriptionPauseArrayOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionPauseArrayOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionPauseArrayOutput) Index

func (PortalConfigurationFeaturesSubscriptionPauseArrayOutput) ToPortalConfigurationFeaturesSubscriptionPauseArrayOutput

func (PortalConfigurationFeaturesSubscriptionPauseArrayOutput) ToPortalConfigurationFeaturesSubscriptionPauseArrayOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionPauseArrayOutput) ToPortalConfigurationFeaturesSubscriptionPauseArrayOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionPauseArrayOutput

type PortalConfigurationFeaturesSubscriptionPauseInput

type PortalConfigurationFeaturesSubscriptionPauseInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionPauseOutput() PortalConfigurationFeaturesSubscriptionPauseOutput
	ToPortalConfigurationFeaturesSubscriptionPauseOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionPauseOutput
}

PortalConfigurationFeaturesSubscriptionPauseInput is an input type that accepts PortalConfigurationFeaturesSubscriptionPauseArgs and PortalConfigurationFeaturesSubscriptionPauseOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionPauseInput` via:

PortalConfigurationFeaturesSubscriptionPauseArgs{...}

type PortalConfigurationFeaturesSubscriptionPauseOutput

type PortalConfigurationFeaturesSubscriptionPauseOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionPauseOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionPauseOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesSubscriptionPauseOutput) ToPortalConfigurationFeaturesSubscriptionPauseOutput

func (o PortalConfigurationFeaturesSubscriptionPauseOutput) ToPortalConfigurationFeaturesSubscriptionPauseOutput() PortalConfigurationFeaturesSubscriptionPauseOutput

func (PortalConfigurationFeaturesSubscriptionPauseOutput) ToPortalConfigurationFeaturesSubscriptionPauseOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionPauseOutput) ToPortalConfigurationFeaturesSubscriptionPauseOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionPauseOutput

type PortalConfigurationFeaturesSubscriptionUpdate

type PortalConfigurationFeaturesSubscriptionUpdate struct {
	// List(String). The types of subscription updates that are supported. When empty, subscriptions are not updatable. Supported values are `price`, `quantity`, and `promotionCode`.
	DefaultAllowedUpdates []string `pulumi:"defaultAllowedUpdates"`
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled bool `pulumi:"enabled"`
	// List(Resource). The list of products that support subscription updates. See details Products.
	Products []PortalConfigurationFeaturesSubscriptionUpdateProduct `pulumi:"products"`
	// String. Whether to create prorations when canceling subscriptions. Possible values are `none` and `createProrations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.
	ProrationBehavior *string `pulumi:"prorationBehavior"`
}

type PortalConfigurationFeaturesSubscriptionUpdateArgs

type PortalConfigurationFeaturesSubscriptionUpdateArgs struct {
	// List(String). The types of subscription updates that are supported. When empty, subscriptions are not updatable. Supported values are `price`, `quantity`, and `promotionCode`.
	DefaultAllowedUpdates pulumi.StringArrayInput `pulumi:"defaultAllowedUpdates"`
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// List(Resource). The list of products that support subscription updates. See details Products.
	Products PortalConfigurationFeaturesSubscriptionUpdateProductArrayInput `pulumi:"products"`
	// String. Whether to create prorations when canceling subscriptions. Possible values are `none` and `createProrations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.
	ProrationBehavior pulumi.StringPtrInput `pulumi:"prorationBehavior"`
}

func (PortalConfigurationFeaturesSubscriptionUpdateArgs) ElementType

func (PortalConfigurationFeaturesSubscriptionUpdateArgs) ToPortalConfigurationFeaturesSubscriptionUpdateOutput

func (i PortalConfigurationFeaturesSubscriptionUpdateArgs) ToPortalConfigurationFeaturesSubscriptionUpdateOutput() PortalConfigurationFeaturesSubscriptionUpdateOutput

func (PortalConfigurationFeaturesSubscriptionUpdateArgs) ToPortalConfigurationFeaturesSubscriptionUpdateOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionUpdateArgs) ToPortalConfigurationFeaturesSubscriptionUpdateOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionUpdateOutput

type PortalConfigurationFeaturesSubscriptionUpdateArray

type PortalConfigurationFeaturesSubscriptionUpdateArray []PortalConfigurationFeaturesSubscriptionUpdateInput

func (PortalConfigurationFeaturesSubscriptionUpdateArray) ElementType

func (PortalConfigurationFeaturesSubscriptionUpdateArray) ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutput

func (i PortalConfigurationFeaturesSubscriptionUpdateArray) ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutput() PortalConfigurationFeaturesSubscriptionUpdateArrayOutput

func (PortalConfigurationFeaturesSubscriptionUpdateArray) ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionUpdateArray) ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionUpdateArrayOutput

type PortalConfigurationFeaturesSubscriptionUpdateArrayInput

type PortalConfigurationFeaturesSubscriptionUpdateArrayInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutput() PortalConfigurationFeaturesSubscriptionUpdateArrayOutput
	ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionUpdateArrayOutput
}

PortalConfigurationFeaturesSubscriptionUpdateArrayInput is an input type that accepts PortalConfigurationFeaturesSubscriptionUpdateArray and PortalConfigurationFeaturesSubscriptionUpdateArrayOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionUpdateArrayInput` via:

PortalConfigurationFeaturesSubscriptionUpdateArray{ PortalConfigurationFeaturesSubscriptionUpdateArgs{...} }

type PortalConfigurationFeaturesSubscriptionUpdateArrayOutput

type PortalConfigurationFeaturesSubscriptionUpdateArrayOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionUpdateArrayOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionUpdateArrayOutput) Index

func (PortalConfigurationFeaturesSubscriptionUpdateArrayOutput) ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutput

func (PortalConfigurationFeaturesSubscriptionUpdateArrayOutput) ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionUpdateArrayOutput) ToPortalConfigurationFeaturesSubscriptionUpdateArrayOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionUpdateArrayOutput

type PortalConfigurationFeaturesSubscriptionUpdateInput

type PortalConfigurationFeaturesSubscriptionUpdateInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionUpdateOutput() PortalConfigurationFeaturesSubscriptionUpdateOutput
	ToPortalConfigurationFeaturesSubscriptionUpdateOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionUpdateOutput
}

PortalConfigurationFeaturesSubscriptionUpdateInput is an input type that accepts PortalConfigurationFeaturesSubscriptionUpdateArgs and PortalConfigurationFeaturesSubscriptionUpdateOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionUpdateInput` via:

PortalConfigurationFeaturesSubscriptionUpdateArgs{...}

type PortalConfigurationFeaturesSubscriptionUpdateOutput

type PortalConfigurationFeaturesSubscriptionUpdateOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionUpdateOutput) DefaultAllowedUpdates

List(String). The types of subscription updates that are supported. When empty, subscriptions are not updatable. Supported values are `price`, `quantity`, and `promotionCode`.

func (PortalConfigurationFeaturesSubscriptionUpdateOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionUpdateOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationFeaturesSubscriptionUpdateOutput) Products

List(Resource). The list of products that support subscription updates. See details Products.

func (PortalConfigurationFeaturesSubscriptionUpdateOutput) ProrationBehavior

String. Whether to create prorations when canceling subscriptions. Possible values are `none` and `createProrations`, which is only compatible with `mode=immediately`. No prorations are generated when canceling a subscription at the end of its natural billing period.

func (PortalConfigurationFeaturesSubscriptionUpdateOutput) ToPortalConfigurationFeaturesSubscriptionUpdateOutput

func (o PortalConfigurationFeaturesSubscriptionUpdateOutput) ToPortalConfigurationFeaturesSubscriptionUpdateOutput() PortalConfigurationFeaturesSubscriptionUpdateOutput

func (PortalConfigurationFeaturesSubscriptionUpdateOutput) ToPortalConfigurationFeaturesSubscriptionUpdateOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionUpdateOutput) ToPortalConfigurationFeaturesSubscriptionUpdateOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionUpdateOutput

type PortalConfigurationFeaturesSubscriptionUpdateProduct

type PortalConfigurationFeaturesSubscriptionUpdateProduct struct {
	// List(String). The list of price IDs for the product that a subscription can be updated to.
	Prices []string `pulumi:"prices"`
	// String. The product id.
	Product string `pulumi:"product"`
}

type PortalConfigurationFeaturesSubscriptionUpdateProductArgs

type PortalConfigurationFeaturesSubscriptionUpdateProductArgs struct {
	// List(String). The list of price IDs for the product that a subscription can be updated to.
	Prices pulumi.StringArrayInput `pulumi:"prices"`
	// String. The product id.
	Product pulumi.StringInput `pulumi:"product"`
}

func (PortalConfigurationFeaturesSubscriptionUpdateProductArgs) ElementType

func (PortalConfigurationFeaturesSubscriptionUpdateProductArgs) ToPortalConfigurationFeaturesSubscriptionUpdateProductOutput

func (PortalConfigurationFeaturesSubscriptionUpdateProductArgs) ToPortalConfigurationFeaturesSubscriptionUpdateProductOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionUpdateProductArgs) ToPortalConfigurationFeaturesSubscriptionUpdateProductOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionUpdateProductOutput

type PortalConfigurationFeaturesSubscriptionUpdateProductArray

type PortalConfigurationFeaturesSubscriptionUpdateProductArray []PortalConfigurationFeaturesSubscriptionUpdateProductInput

func (PortalConfigurationFeaturesSubscriptionUpdateProductArray) ElementType

func (PortalConfigurationFeaturesSubscriptionUpdateProductArray) ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput

func (i PortalConfigurationFeaturesSubscriptionUpdateProductArray) ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput() PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput

func (PortalConfigurationFeaturesSubscriptionUpdateProductArray) ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutputWithContext

func (i PortalConfigurationFeaturesSubscriptionUpdateProductArray) ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput

type PortalConfigurationFeaturesSubscriptionUpdateProductArrayInput

type PortalConfigurationFeaturesSubscriptionUpdateProductArrayInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput() PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput
	ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput
}

PortalConfigurationFeaturesSubscriptionUpdateProductArrayInput is an input type that accepts PortalConfigurationFeaturesSubscriptionUpdateProductArray and PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionUpdateProductArrayInput` via:

PortalConfigurationFeaturesSubscriptionUpdateProductArray{ PortalConfigurationFeaturesSubscriptionUpdateProductArgs{...} }

type PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput

type PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput) Index

func (PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput) ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput

func (PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput) ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput) ToPortalConfigurationFeaturesSubscriptionUpdateProductArrayOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionUpdateProductArrayOutput

type PortalConfigurationFeaturesSubscriptionUpdateProductInput

type PortalConfigurationFeaturesSubscriptionUpdateProductInput interface {
	pulumi.Input

	ToPortalConfigurationFeaturesSubscriptionUpdateProductOutput() PortalConfigurationFeaturesSubscriptionUpdateProductOutput
	ToPortalConfigurationFeaturesSubscriptionUpdateProductOutputWithContext(context.Context) PortalConfigurationFeaturesSubscriptionUpdateProductOutput
}

PortalConfigurationFeaturesSubscriptionUpdateProductInput is an input type that accepts PortalConfigurationFeaturesSubscriptionUpdateProductArgs and PortalConfigurationFeaturesSubscriptionUpdateProductOutput values. You can construct a concrete instance of `PortalConfigurationFeaturesSubscriptionUpdateProductInput` via:

PortalConfigurationFeaturesSubscriptionUpdateProductArgs{...}

type PortalConfigurationFeaturesSubscriptionUpdateProductOutput

type PortalConfigurationFeaturesSubscriptionUpdateProductOutput struct{ *pulumi.OutputState }

func (PortalConfigurationFeaturesSubscriptionUpdateProductOutput) ElementType

func (PortalConfigurationFeaturesSubscriptionUpdateProductOutput) Prices

List(String). The list of price IDs for the product that a subscription can be updated to.

func (PortalConfigurationFeaturesSubscriptionUpdateProductOutput) Product

String. The product id.

func (PortalConfigurationFeaturesSubscriptionUpdateProductOutput) ToPortalConfigurationFeaturesSubscriptionUpdateProductOutput

func (PortalConfigurationFeaturesSubscriptionUpdateProductOutput) ToPortalConfigurationFeaturesSubscriptionUpdateProductOutputWithContext

func (o PortalConfigurationFeaturesSubscriptionUpdateProductOutput) ToPortalConfigurationFeaturesSubscriptionUpdateProductOutputWithContext(ctx context.Context) PortalConfigurationFeaturesSubscriptionUpdateProductOutput

type PortalConfigurationInput

type PortalConfigurationInput interface {
	pulumi.Input

	ToPortalConfigurationOutput() PortalConfigurationOutput
	ToPortalConfigurationOutputWithContext(ctx context.Context) PortalConfigurationOutput
}

type PortalConfigurationLoginPage

type PortalConfigurationLoginPage struct {
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled *bool   `pulumi:"enabled"`
	Url     *string `pulumi:"url"`
}

type PortalConfigurationLoginPageArgs

type PortalConfigurationLoginPageArgs struct {
	// Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.
	Enabled pulumi.BoolPtrInput   `pulumi:"enabled"`
	Url     pulumi.StringPtrInput `pulumi:"url"`
}

func (PortalConfigurationLoginPageArgs) ElementType

func (PortalConfigurationLoginPageArgs) ToPortalConfigurationLoginPageOutput

func (i PortalConfigurationLoginPageArgs) ToPortalConfigurationLoginPageOutput() PortalConfigurationLoginPageOutput

func (PortalConfigurationLoginPageArgs) ToPortalConfigurationLoginPageOutputWithContext

func (i PortalConfigurationLoginPageArgs) ToPortalConfigurationLoginPageOutputWithContext(ctx context.Context) PortalConfigurationLoginPageOutput

func (PortalConfigurationLoginPageArgs) ToPortalConfigurationLoginPagePtrOutput

func (i PortalConfigurationLoginPageArgs) ToPortalConfigurationLoginPagePtrOutput() PortalConfigurationLoginPagePtrOutput

func (PortalConfigurationLoginPageArgs) ToPortalConfigurationLoginPagePtrOutputWithContext

func (i PortalConfigurationLoginPageArgs) ToPortalConfigurationLoginPagePtrOutputWithContext(ctx context.Context) PortalConfigurationLoginPagePtrOutput

type PortalConfigurationLoginPageInput

type PortalConfigurationLoginPageInput interface {
	pulumi.Input

	ToPortalConfigurationLoginPageOutput() PortalConfigurationLoginPageOutput
	ToPortalConfigurationLoginPageOutputWithContext(context.Context) PortalConfigurationLoginPageOutput
}

PortalConfigurationLoginPageInput is an input type that accepts PortalConfigurationLoginPageArgs and PortalConfigurationLoginPageOutput values. You can construct a concrete instance of `PortalConfigurationLoginPageInput` via:

PortalConfigurationLoginPageArgs{...}

type PortalConfigurationLoginPageOutput

type PortalConfigurationLoginPageOutput struct{ *pulumi.OutputState }

func (PortalConfigurationLoginPageOutput) ElementType

func (PortalConfigurationLoginPageOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationLoginPageOutput) ToPortalConfigurationLoginPageOutput

func (o PortalConfigurationLoginPageOutput) ToPortalConfigurationLoginPageOutput() PortalConfigurationLoginPageOutput

func (PortalConfigurationLoginPageOutput) ToPortalConfigurationLoginPageOutputWithContext

func (o PortalConfigurationLoginPageOutput) ToPortalConfigurationLoginPageOutputWithContext(ctx context.Context) PortalConfigurationLoginPageOutput

func (PortalConfigurationLoginPageOutput) ToPortalConfigurationLoginPagePtrOutput

func (o PortalConfigurationLoginPageOutput) ToPortalConfigurationLoginPagePtrOutput() PortalConfigurationLoginPagePtrOutput

func (PortalConfigurationLoginPageOutput) ToPortalConfigurationLoginPagePtrOutputWithContext

func (o PortalConfigurationLoginPageOutput) ToPortalConfigurationLoginPagePtrOutputWithContext(ctx context.Context) PortalConfigurationLoginPagePtrOutput

func (PortalConfigurationLoginPageOutput) Url

type PortalConfigurationLoginPagePtrInput

type PortalConfigurationLoginPagePtrInput interface {
	pulumi.Input

	ToPortalConfigurationLoginPagePtrOutput() PortalConfigurationLoginPagePtrOutput
	ToPortalConfigurationLoginPagePtrOutputWithContext(context.Context) PortalConfigurationLoginPagePtrOutput
}

PortalConfigurationLoginPagePtrInput is an input type that accepts PortalConfigurationLoginPageArgs, PortalConfigurationLoginPagePtr and PortalConfigurationLoginPagePtrOutput values. You can construct a concrete instance of `PortalConfigurationLoginPagePtrInput` via:

        PortalConfigurationLoginPageArgs{...}

or:

        nil

type PortalConfigurationLoginPagePtrOutput

type PortalConfigurationLoginPagePtrOutput struct{ *pulumi.OutputState }

func (PortalConfigurationLoginPagePtrOutput) Elem

func (PortalConfigurationLoginPagePtrOutput) ElementType

func (PortalConfigurationLoginPagePtrOutput) Enabled

Bool. Set to true to generate a shareable URL login_page.url that will take your customers to a hosted login page for the customer portal.

func (PortalConfigurationLoginPagePtrOutput) ToPortalConfigurationLoginPagePtrOutput

func (o PortalConfigurationLoginPagePtrOutput) ToPortalConfigurationLoginPagePtrOutput() PortalConfigurationLoginPagePtrOutput

func (PortalConfigurationLoginPagePtrOutput) ToPortalConfigurationLoginPagePtrOutputWithContext

func (o PortalConfigurationLoginPagePtrOutput) ToPortalConfigurationLoginPagePtrOutputWithContext(ctx context.Context) PortalConfigurationLoginPagePtrOutput

func (PortalConfigurationLoginPagePtrOutput) Url

type PortalConfigurationMap

type PortalConfigurationMap map[string]PortalConfigurationInput

func (PortalConfigurationMap) ElementType

func (PortalConfigurationMap) ElementType() reflect.Type

func (PortalConfigurationMap) ToPortalConfigurationMapOutput

func (i PortalConfigurationMap) ToPortalConfigurationMapOutput() PortalConfigurationMapOutput

func (PortalConfigurationMap) ToPortalConfigurationMapOutputWithContext

func (i PortalConfigurationMap) ToPortalConfigurationMapOutputWithContext(ctx context.Context) PortalConfigurationMapOutput

type PortalConfigurationMapInput

type PortalConfigurationMapInput interface {
	pulumi.Input

	ToPortalConfigurationMapOutput() PortalConfigurationMapOutput
	ToPortalConfigurationMapOutputWithContext(context.Context) PortalConfigurationMapOutput
}

PortalConfigurationMapInput is an input type that accepts PortalConfigurationMap and PortalConfigurationMapOutput values. You can construct a concrete instance of `PortalConfigurationMapInput` via:

PortalConfigurationMap{ "key": PortalConfigurationArgs{...} }

type PortalConfigurationMapOutput

type PortalConfigurationMapOutput struct{ *pulumi.OutputState }

func (PortalConfigurationMapOutput) ElementType

func (PortalConfigurationMapOutput) MapIndex

func (PortalConfigurationMapOutput) ToPortalConfigurationMapOutput

func (o PortalConfigurationMapOutput) ToPortalConfigurationMapOutput() PortalConfigurationMapOutput

func (PortalConfigurationMapOutput) ToPortalConfigurationMapOutputWithContext

func (o PortalConfigurationMapOutput) ToPortalConfigurationMapOutputWithContext(ctx context.Context) PortalConfigurationMapOutput

type PortalConfigurationOutput

type PortalConfigurationOutput struct{ *pulumi.OutputState }

func (PortalConfigurationOutput) Active

Bool. Whether the configuration is active and can be used to create portal sessions. (On create it is always set as `true`)

func (PortalConfigurationOutput) BusinessProfile

List(Resource). The business information shown to customers in the portal. More details in Business Profile section

func (PortalConfigurationOutput) DefaultReturnUrl

func (o PortalConfigurationOutput) DefaultReturnUrl() pulumi.StringPtrOutput

String. The default URL to redirect customers to when they click on the portal’s link to return to your website. This can be overriden when creating the session.

func (PortalConfigurationOutput) ElementType

func (PortalConfigurationOutput) ElementType() reflect.Type

func (PortalConfigurationOutput) Features

List(Resource). Information about the features available in the portal. Feature section described in Feature section

func (PortalConfigurationOutput) LoginPage

List(Resource). The hosted login page for this configuration. See details in Login Page Section.

func (PortalConfigurationOutput) Metadata

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

func (PortalConfigurationOutput) ToPortalConfigurationOutput

func (o PortalConfigurationOutput) ToPortalConfigurationOutput() PortalConfigurationOutput

func (PortalConfigurationOutput) ToPortalConfigurationOutputWithContext

func (o PortalConfigurationOutput) ToPortalConfigurationOutputWithContext(ctx context.Context) PortalConfigurationOutput

type PortalConfigurationState

type PortalConfigurationState struct {
	// Bool. Whether the configuration is active and can be used to create portal sessions. (On create it is always set as `true`)
	Active pulumi.BoolPtrInput
	// List(Resource). The business information shown to customers in the portal. More details in Business Profile section
	BusinessProfile PortalConfigurationBusinessProfilePtrInput
	// String. The default URL to redirect customers to when they click on the portal’s link to return to your website. This can be overriden when creating the session.
	DefaultReturnUrl pulumi.StringPtrInput
	// List(Resource). Information about the features available in the portal. Feature section described in Feature section
	Features PortalConfigurationFeaturesPtrInput
	// List(Resource). The hosted login page for this configuration. See details in Login Page Section.
	LoginPage PortalConfigurationLoginPagePtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
}

func (PortalConfigurationState) ElementType

func (PortalConfigurationState) ElementType() reflect.Type

type Price

type Price struct {
	pulumi.CustomResourceState

	// Bool. Whether the price can be used for new purchases. Defaults to `true`.
	Active pulumi.BoolPtrOutput `pulumi:"active"`
	// String. Describes how to compute the price per period. Either `perUnit` or `tiered`
	// . `perUnit` indicates that the fixed amount (specified in `unitAmount` or `unitAmountDecimal`) will be charged per
	// unit in quantity (for prices with `usage_type=licensed`), or per unit of total usage (for prices
	// with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as
	// defined using the `tiers` and `tiersMode` attributes.
	BillingScheme pulumi.StringPtrOutput `pulumi:"billingScheme"`
	// String. Three-letter ISO currency code, in lowercase - [supported currencies](https://stripe.com/docs/currencies).
	Currency pulumi.StringOutput `pulumi:"currency"`
	// List(Resource). Prices defined in each available currency option. For details
	// of individual arguments see Currency Options.
	CurrencyOptions PriceCurrencyOptionArrayOutput `pulumi:"currencyOptions"`
	// String. A lookup key used to retrieve prices dynamically from a static string.
	LookupKey pulumi.StringPtrOutput `pulumi:"lookupKey"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for
	// storing additional information about the object in a structured format.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// String. A brief description of the price, hidden from customers.
	Nickname pulumi.StringPtrOutput `pulumi:"nickname"`
	// String. The ID of the product that this price will belong to.
	Product pulumi.StringOutput `pulumi:"product"`
	// List(Resource). The recurring components of a price such as `interval` and `usageType`. For
	// details of individual arguments see Recurring.
	Recurring PriceRecurringPtrOutput `pulumi:"recurring"`
	// String. Specifies whether the price is considered inclusive of taxes or exclusive of
	// taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it
	// cannot be changed, default is `unspecified`.
	TaxBehaviour pulumi.StringPtrOutput `pulumi:"taxBehaviour"`
	// List(Resource). Each element represents a pricing tier. This parameter requires `billingScheme`
	// to be set to `tiered`. See also the documentation for `billingScheme`. For details of individual arguments
	// see Tiers.
	Tiers PriceTierArrayOutput `pulumi:"tiers"`
	// String. Defines if the tiering price should be `graduated`
	// or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per-unit price,
	// in `graduated` tiering pricing can successively change as the quantity grows.
	TiersMode pulumi.StringPtrOutput `pulumi:"tiersMode"`
	// Bool. If set to `true`, will atomically remove the lookup key from the existing
	// price, and assign it to this price.
	TransferLookupKey pulumi.BoolPtrOutput `pulumi:"transferLookupKey"`
	// List(Resource). Apply a transformation to the reported usage or set quantity before
	// computing the billed price. Cannot be combined with `tiers`. For details of individual arguments
	// see Transform Quantity.
	TransformQuantity PriceTransformQuantityPtrOutput `pulumi:"transformQuantity"`
	// String. One of `oneTime` or `recurring` depending on whether the price is for a one-time purchase or a
	// recurring (subscription) purchase.
	Type pulumi.StringOutput `pulumi:"type"`
	// Int. A positive integer in cents (or `-1` for a free
	// price) representing how much to charge.
	UnitAmount pulumi.IntPtrOutput `pulumi:"unitAmount"`
	// Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.
	UnitAmountDecimal pulumi.Float64PtrOutput `pulumi:"unitAmountDecimal"`
}

With this resource, you can create a price - [Stripe API price documentation](https://stripe.com/docs/api/prices).

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms.

Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.

> Removal of the price isn't supported through the Stripe SDK. The best practice, which this provider follows, is to archive the price by marking it as inactive on destroy, which indicates that the price is not longer available for purchase.

## Example Usage

```go package main

import (

"github.com/georgegebbett/pulumi-stripe/sdk/go/stripe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stripe.NewPrice(ctx, "pricePrice", &stripe.PriceArgs{
			Product:    pulumi.Any(stripe_product.Product.Id),
			Currency:   pulumi.String("aud"),
			UnitAmount: pulumi.Int(100),
		})
		if err != nil {
			return err
		}
		_, err = stripe.NewPrice(ctx, "priceIndex/pricePrice", &stripe.PriceArgs{
			Product:    pulumi.Any(stripe_product.Product.Id),
			Currency:   pulumi.String("aud"),
			UnitAmount: -1,
		})
		if err != nil {
			return err
		}
		_, err = stripe.NewPrice(ctx, "priceStripeIndex/pricePrice", &stripe.PriceArgs{
			Product:       pulumi.Any(stripe_product.Product.Id),
			Currency:      pulumi.String("aud"),
			BillingScheme: pulumi.String("per_unit"),
			UnitAmount:    pulumi.Int(100),
			Recurring: &stripe.PriceRecurringArgs{
				Interval:      pulumi.String("week"),
				IntervalCount: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		_, err = stripe.NewPrice(ctx, "priceStripeIndex/pricePrice1", &stripe.PriceArgs{
			Product:       pulumi.Any(stripe_product.Product.Id),
			Currency:      pulumi.String("aud"),
			BillingScheme: pulumi.String("tiered"),
			TiersMode:     pulumi.String("graduated"),
			Tiers: stripe.PriceTierArray{
				&stripe.PriceTierArgs{
					UpTo:       pulumi.Int(10),
					UnitAmount: pulumi.Int(0),
				},
				&stripe.PriceTierArgs{
					UpTo:       pulumi.Int(100),
					UnitAmount: pulumi.Int(300),
				},
				&stripe.PriceTierArgs{
					UpTo:       -1,
					UnitAmount: pulumi.Int(100.5),
				},
			},
			Recurring: &stripe.PriceRecurringArgs{
				Interval:       pulumi.String("week"),
				AggregateUsage: pulumi.String("sum"),
				IntervalCount:  pulumi.Int(2),
				UsageType:      pulumi.String("metered"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ## Note on updating prices

Once created, you can update the `active`, `metadata`, `nickname`, `lookupKey`, `taxBehaviour` (only if unspecified) and `transferLookupKey` attributes.

Other attribute edits will trigger a destroy action (archival) and creation of a new price entry.

func GetPrice

func GetPrice(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PriceState, opts ...pulumi.ResourceOption) (*Price, error)

GetPrice gets an existing Price resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPrice

func NewPrice(ctx *pulumi.Context,
	name string, args *PriceArgs, opts ...pulumi.ResourceOption) (*Price, error)

NewPrice registers a new resource with the given unique name, arguments, and options.

func (*Price) ElementType

func (*Price) ElementType() reflect.Type

func (*Price) ToPriceOutput

func (i *Price) ToPriceOutput() PriceOutput

func (*Price) ToPriceOutputWithContext

func (i *Price) ToPriceOutputWithContext(ctx context.Context) PriceOutput

type PriceArgs

type PriceArgs struct {
	// Bool. Whether the price can be used for new purchases. Defaults to `true`.
	Active pulumi.BoolPtrInput
	// String. Describes how to compute the price per period. Either `perUnit` or `tiered`
	// . `perUnit` indicates that the fixed amount (specified in `unitAmount` or `unitAmountDecimal`) will be charged per
	// unit in quantity (for prices with `usage_type=licensed`), or per unit of total usage (for prices
	// with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as
	// defined using the `tiers` and `tiersMode` attributes.
	BillingScheme pulumi.StringPtrInput
	// String. Three-letter ISO currency code, in lowercase - [supported currencies](https://stripe.com/docs/currencies).
	Currency pulumi.StringInput
	// List(Resource). Prices defined in each available currency option. For details
	// of individual arguments see Currency Options.
	CurrencyOptions PriceCurrencyOptionArrayInput
	// String. A lookup key used to retrieve prices dynamically from a static string.
	LookupKey pulumi.StringPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for
	// storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. A brief description of the price, hidden from customers.
	Nickname pulumi.StringPtrInput
	// String. The ID of the product that this price will belong to.
	Product pulumi.StringInput
	// List(Resource). The recurring components of a price such as `interval` and `usageType`. For
	// details of individual arguments see Recurring.
	Recurring PriceRecurringPtrInput
	// String. Specifies whether the price is considered inclusive of taxes or exclusive of
	// taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it
	// cannot be changed, default is `unspecified`.
	TaxBehaviour pulumi.StringPtrInput
	// List(Resource). Each element represents a pricing tier. This parameter requires `billingScheme`
	// to be set to `tiered`. See also the documentation for `billingScheme`. For details of individual arguments
	// see Tiers.
	Tiers PriceTierArrayInput
	// String. Defines if the tiering price should be `graduated`
	// or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per-unit price,
	// in `graduated` tiering pricing can successively change as the quantity grows.
	TiersMode pulumi.StringPtrInput
	// Bool. If set to `true`, will atomically remove the lookup key from the existing
	// price, and assign it to this price.
	TransferLookupKey pulumi.BoolPtrInput
	// List(Resource). Apply a transformation to the reported usage or set quantity before
	// computing the billed price. Cannot be combined with `tiers`. For details of individual arguments
	// see Transform Quantity.
	TransformQuantity PriceTransformQuantityPtrInput
	// Int. A positive integer in cents (or `-1` for a free
	// price) representing how much to charge.
	UnitAmount pulumi.IntPtrInput
	// Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.
	UnitAmountDecimal pulumi.Float64PtrInput
}

The set of arguments for constructing a Price resource.

func (PriceArgs) ElementType

func (PriceArgs) ElementType() reflect.Type

type PriceArray

type PriceArray []PriceInput

func (PriceArray) ElementType

func (PriceArray) ElementType() reflect.Type

func (PriceArray) ToPriceArrayOutput

func (i PriceArray) ToPriceArrayOutput() PriceArrayOutput

func (PriceArray) ToPriceArrayOutputWithContext

func (i PriceArray) ToPriceArrayOutputWithContext(ctx context.Context) PriceArrayOutput

type PriceArrayInput

type PriceArrayInput interface {
	pulumi.Input

	ToPriceArrayOutput() PriceArrayOutput
	ToPriceArrayOutputWithContext(context.Context) PriceArrayOutput
}

PriceArrayInput is an input type that accepts PriceArray and PriceArrayOutput values. You can construct a concrete instance of `PriceArrayInput` via:

PriceArray{ PriceArgs{...} }

type PriceArrayOutput

type PriceArrayOutput struct{ *pulumi.OutputState }

func (PriceArrayOutput) ElementType

func (PriceArrayOutput) ElementType() reflect.Type

func (PriceArrayOutput) Index

func (PriceArrayOutput) ToPriceArrayOutput

func (o PriceArrayOutput) ToPriceArrayOutput() PriceArrayOutput

func (PriceArrayOutput) ToPriceArrayOutputWithContext

func (o PriceArrayOutput) ToPriceArrayOutputWithContext(ctx context.Context) PriceArrayOutput

type PriceCurrencyOption

type PriceCurrencyOption struct {
	// String. Three-letter ISO currency code, in lowercase - [supported currencies](https://stripe.com/docs/currencies).
	Currency string `pulumi:"currency"`
	// List(Resource). When set,
	// provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
	// See details in custom unit amount.
	CustomUnitAmount *PriceCurrencyOptionCustomUnitAmount `pulumi:"customUnitAmount"`
	// String. Only required if a default tax behavior was not provided in the Stripe Tax settings.
	// Specifies whether the price is considered inclusive of taxes or exclusive of taxes.
	// One of `inclusive`, `exclusive`, or `unspecified`.
	// Once specified as either inclusive or exclusive, it cannot be changed.
	TaxBehavior *string `pulumi:"taxBehavior"`
	// List(Resource). Each element represents a pricing tier.
	// This parameter requires `billingScheme` to be set to `tiered`. This resource can be used more than once and follows
	// the same fields as the root tiers block
	Tiers []PriceCurrencyOptionTier `pulumi:"tiers"`
	// Int. A positive integer in cents (or 0 for a free price) representing how much to charge.
	UnitAmount *int `pulumi:"unitAmount"`
	// Float. Same as unit_amount, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of unitAmount and unitAmountDecimal can be set.
	UnitAmountDecimal *float64 `pulumi:"unitAmountDecimal"`
}

type PriceCurrencyOptionArgs

type PriceCurrencyOptionArgs struct {
	// String. Three-letter ISO currency code, in lowercase - [supported currencies](https://stripe.com/docs/currencies).
	Currency pulumi.StringInput `pulumi:"currency"`
	// List(Resource). When set,
	// provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
	// See details in custom unit amount.
	CustomUnitAmount PriceCurrencyOptionCustomUnitAmountPtrInput `pulumi:"customUnitAmount"`
	// String. Only required if a default tax behavior was not provided in the Stripe Tax settings.
	// Specifies whether the price is considered inclusive of taxes or exclusive of taxes.
	// One of `inclusive`, `exclusive`, or `unspecified`.
	// Once specified as either inclusive or exclusive, it cannot be changed.
	TaxBehavior pulumi.StringPtrInput `pulumi:"taxBehavior"`
	// List(Resource). Each element represents a pricing tier.
	// This parameter requires `billingScheme` to be set to `tiered`. This resource can be used more than once and follows
	// the same fields as the root tiers block
	Tiers PriceCurrencyOptionTierArrayInput `pulumi:"tiers"`
	// Int. A positive integer in cents (or 0 for a free price) representing how much to charge.
	UnitAmount pulumi.IntPtrInput `pulumi:"unitAmount"`
	// Float. Same as unit_amount, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of unitAmount and unitAmountDecimal can be set.
	UnitAmountDecimal pulumi.Float64PtrInput `pulumi:"unitAmountDecimal"`
}

func (PriceCurrencyOptionArgs) ElementType

func (PriceCurrencyOptionArgs) ElementType() reflect.Type

func (PriceCurrencyOptionArgs) ToPriceCurrencyOptionOutput

func (i PriceCurrencyOptionArgs) ToPriceCurrencyOptionOutput() PriceCurrencyOptionOutput

func (PriceCurrencyOptionArgs) ToPriceCurrencyOptionOutputWithContext

func (i PriceCurrencyOptionArgs) ToPriceCurrencyOptionOutputWithContext(ctx context.Context) PriceCurrencyOptionOutput

type PriceCurrencyOptionArray

type PriceCurrencyOptionArray []PriceCurrencyOptionInput

func (PriceCurrencyOptionArray) ElementType

func (PriceCurrencyOptionArray) ElementType() reflect.Type

func (PriceCurrencyOptionArray) ToPriceCurrencyOptionArrayOutput

func (i PriceCurrencyOptionArray) ToPriceCurrencyOptionArrayOutput() PriceCurrencyOptionArrayOutput

func (PriceCurrencyOptionArray) ToPriceCurrencyOptionArrayOutputWithContext

func (i PriceCurrencyOptionArray) ToPriceCurrencyOptionArrayOutputWithContext(ctx context.Context) PriceCurrencyOptionArrayOutput

type PriceCurrencyOptionArrayInput

type PriceCurrencyOptionArrayInput interface {
	pulumi.Input

	ToPriceCurrencyOptionArrayOutput() PriceCurrencyOptionArrayOutput
	ToPriceCurrencyOptionArrayOutputWithContext(context.Context) PriceCurrencyOptionArrayOutput
}

PriceCurrencyOptionArrayInput is an input type that accepts PriceCurrencyOptionArray and PriceCurrencyOptionArrayOutput values. You can construct a concrete instance of `PriceCurrencyOptionArrayInput` via:

PriceCurrencyOptionArray{ PriceCurrencyOptionArgs{...} }

type PriceCurrencyOptionArrayOutput

type PriceCurrencyOptionArrayOutput struct{ *pulumi.OutputState }

func (PriceCurrencyOptionArrayOutput) ElementType

func (PriceCurrencyOptionArrayOutput) Index

func (PriceCurrencyOptionArrayOutput) ToPriceCurrencyOptionArrayOutput

func (o PriceCurrencyOptionArrayOutput) ToPriceCurrencyOptionArrayOutput() PriceCurrencyOptionArrayOutput

func (PriceCurrencyOptionArrayOutput) ToPriceCurrencyOptionArrayOutputWithContext

func (o PriceCurrencyOptionArrayOutput) ToPriceCurrencyOptionArrayOutputWithContext(ctx context.Context) PriceCurrencyOptionArrayOutput

type PriceCurrencyOptionCustomUnitAmount

type PriceCurrencyOptionCustomUnitAmount struct {
	// Bool. Pass in `true` to enable `customUnitAmount`, otherwise omit `customUnitAmount`.
	Enabled bool `pulumi:"enabled"`
	// Int. The maximum unit amount the customer can specify for this item.
	Maximum *int `pulumi:"maximum"`
	// Int. The minimum unit amount the customer can specify for this item.
	// Must be at least the minimum charge amount.
	Minimum *int `pulumi:"minimum"`
	// Int. The starting unit amount which can be updated by the customer.
	Preset *int `pulumi:"preset"`
}

type PriceCurrencyOptionCustomUnitAmountArgs

type PriceCurrencyOptionCustomUnitAmountArgs struct {
	// Bool. Pass in `true` to enable `customUnitAmount`, otherwise omit `customUnitAmount`.
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// Int. The maximum unit amount the customer can specify for this item.
	Maximum pulumi.IntPtrInput `pulumi:"maximum"`
	// Int. The minimum unit amount the customer can specify for this item.
	// Must be at least the minimum charge amount.
	Minimum pulumi.IntPtrInput `pulumi:"minimum"`
	// Int. The starting unit amount which can be updated by the customer.
	Preset pulumi.IntPtrInput `pulumi:"preset"`
}

func (PriceCurrencyOptionCustomUnitAmountArgs) ElementType

func (PriceCurrencyOptionCustomUnitAmountArgs) ToPriceCurrencyOptionCustomUnitAmountOutput

func (i PriceCurrencyOptionCustomUnitAmountArgs) ToPriceCurrencyOptionCustomUnitAmountOutput() PriceCurrencyOptionCustomUnitAmountOutput

func (PriceCurrencyOptionCustomUnitAmountArgs) ToPriceCurrencyOptionCustomUnitAmountOutputWithContext

func (i PriceCurrencyOptionCustomUnitAmountArgs) ToPriceCurrencyOptionCustomUnitAmountOutputWithContext(ctx context.Context) PriceCurrencyOptionCustomUnitAmountOutput

func (PriceCurrencyOptionCustomUnitAmountArgs) ToPriceCurrencyOptionCustomUnitAmountPtrOutput

func (i PriceCurrencyOptionCustomUnitAmountArgs) ToPriceCurrencyOptionCustomUnitAmountPtrOutput() PriceCurrencyOptionCustomUnitAmountPtrOutput

func (PriceCurrencyOptionCustomUnitAmountArgs) ToPriceCurrencyOptionCustomUnitAmountPtrOutputWithContext

func (i PriceCurrencyOptionCustomUnitAmountArgs) ToPriceCurrencyOptionCustomUnitAmountPtrOutputWithContext(ctx context.Context) PriceCurrencyOptionCustomUnitAmountPtrOutput

type PriceCurrencyOptionCustomUnitAmountInput

type PriceCurrencyOptionCustomUnitAmountInput interface {
	pulumi.Input

	ToPriceCurrencyOptionCustomUnitAmountOutput() PriceCurrencyOptionCustomUnitAmountOutput
	ToPriceCurrencyOptionCustomUnitAmountOutputWithContext(context.Context) PriceCurrencyOptionCustomUnitAmountOutput
}

PriceCurrencyOptionCustomUnitAmountInput is an input type that accepts PriceCurrencyOptionCustomUnitAmountArgs and PriceCurrencyOptionCustomUnitAmountOutput values. You can construct a concrete instance of `PriceCurrencyOptionCustomUnitAmountInput` via:

PriceCurrencyOptionCustomUnitAmountArgs{...}

type PriceCurrencyOptionCustomUnitAmountOutput

type PriceCurrencyOptionCustomUnitAmountOutput struct{ *pulumi.OutputState }

func (PriceCurrencyOptionCustomUnitAmountOutput) ElementType

func (PriceCurrencyOptionCustomUnitAmountOutput) Enabled

Bool. Pass in `true` to enable `customUnitAmount`, otherwise omit `customUnitAmount`.

func (PriceCurrencyOptionCustomUnitAmountOutput) Maximum

Int. The maximum unit amount the customer can specify for this item.

func (PriceCurrencyOptionCustomUnitAmountOutput) Minimum

Int. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

func (PriceCurrencyOptionCustomUnitAmountOutput) Preset

Int. The starting unit amount which can be updated by the customer.

func (PriceCurrencyOptionCustomUnitAmountOutput) ToPriceCurrencyOptionCustomUnitAmountOutput

func (o PriceCurrencyOptionCustomUnitAmountOutput) ToPriceCurrencyOptionCustomUnitAmountOutput() PriceCurrencyOptionCustomUnitAmountOutput

func (PriceCurrencyOptionCustomUnitAmountOutput) ToPriceCurrencyOptionCustomUnitAmountOutputWithContext

func (o PriceCurrencyOptionCustomUnitAmountOutput) ToPriceCurrencyOptionCustomUnitAmountOutputWithContext(ctx context.Context) PriceCurrencyOptionCustomUnitAmountOutput

func (PriceCurrencyOptionCustomUnitAmountOutput) ToPriceCurrencyOptionCustomUnitAmountPtrOutput

func (o PriceCurrencyOptionCustomUnitAmountOutput) ToPriceCurrencyOptionCustomUnitAmountPtrOutput() PriceCurrencyOptionCustomUnitAmountPtrOutput

func (PriceCurrencyOptionCustomUnitAmountOutput) ToPriceCurrencyOptionCustomUnitAmountPtrOutputWithContext

func (o PriceCurrencyOptionCustomUnitAmountOutput) ToPriceCurrencyOptionCustomUnitAmountPtrOutputWithContext(ctx context.Context) PriceCurrencyOptionCustomUnitAmountPtrOutput

type PriceCurrencyOptionCustomUnitAmountPtrInput

type PriceCurrencyOptionCustomUnitAmountPtrInput interface {
	pulumi.Input

	ToPriceCurrencyOptionCustomUnitAmountPtrOutput() PriceCurrencyOptionCustomUnitAmountPtrOutput
	ToPriceCurrencyOptionCustomUnitAmountPtrOutputWithContext(context.Context) PriceCurrencyOptionCustomUnitAmountPtrOutput
}

PriceCurrencyOptionCustomUnitAmountPtrInput is an input type that accepts PriceCurrencyOptionCustomUnitAmountArgs, PriceCurrencyOptionCustomUnitAmountPtr and PriceCurrencyOptionCustomUnitAmountPtrOutput values. You can construct a concrete instance of `PriceCurrencyOptionCustomUnitAmountPtrInput` via:

        PriceCurrencyOptionCustomUnitAmountArgs{...}

or:

        nil

type PriceCurrencyOptionCustomUnitAmountPtrOutput

type PriceCurrencyOptionCustomUnitAmountPtrOutput struct{ *pulumi.OutputState }

func (PriceCurrencyOptionCustomUnitAmountPtrOutput) Elem

func (PriceCurrencyOptionCustomUnitAmountPtrOutput) ElementType

func (PriceCurrencyOptionCustomUnitAmountPtrOutput) Enabled

Bool. Pass in `true` to enable `customUnitAmount`, otherwise omit `customUnitAmount`.

func (PriceCurrencyOptionCustomUnitAmountPtrOutput) Maximum

Int. The maximum unit amount the customer can specify for this item.

func (PriceCurrencyOptionCustomUnitAmountPtrOutput) Minimum

Int. The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

func (PriceCurrencyOptionCustomUnitAmountPtrOutput) Preset

Int. The starting unit amount which can be updated by the customer.

func (PriceCurrencyOptionCustomUnitAmountPtrOutput) ToPriceCurrencyOptionCustomUnitAmountPtrOutput

func (o PriceCurrencyOptionCustomUnitAmountPtrOutput) ToPriceCurrencyOptionCustomUnitAmountPtrOutput() PriceCurrencyOptionCustomUnitAmountPtrOutput

func (PriceCurrencyOptionCustomUnitAmountPtrOutput) ToPriceCurrencyOptionCustomUnitAmountPtrOutputWithContext

func (o PriceCurrencyOptionCustomUnitAmountPtrOutput) ToPriceCurrencyOptionCustomUnitAmountPtrOutputWithContext(ctx context.Context) PriceCurrencyOptionCustomUnitAmountPtrOutput

type PriceCurrencyOptionInput

type PriceCurrencyOptionInput interface {
	pulumi.Input

	ToPriceCurrencyOptionOutput() PriceCurrencyOptionOutput
	ToPriceCurrencyOptionOutputWithContext(context.Context) PriceCurrencyOptionOutput
}

PriceCurrencyOptionInput is an input type that accepts PriceCurrencyOptionArgs and PriceCurrencyOptionOutput values. You can construct a concrete instance of `PriceCurrencyOptionInput` via:

PriceCurrencyOptionArgs{...}

type PriceCurrencyOptionOutput

type PriceCurrencyOptionOutput struct{ *pulumi.OutputState }

func (PriceCurrencyOptionOutput) Currency

String. Three-letter ISO currency code, in lowercase - [supported currencies](https://stripe.com/docs/currencies).

func (PriceCurrencyOptionOutput) CustomUnitAmount

List(Resource). When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. See details in custom unit amount.

func (PriceCurrencyOptionOutput) ElementType

func (PriceCurrencyOptionOutput) ElementType() reflect.Type

func (PriceCurrencyOptionOutput) TaxBehavior

String. Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either inclusive or exclusive, it cannot be changed.

func (PriceCurrencyOptionOutput) Tiers

List(Resource). Each element represents a pricing tier. This parameter requires `billingScheme` to be set to `tiered`. This resource can be used more than once and follows the same fields as the root tiers block

func (PriceCurrencyOptionOutput) ToPriceCurrencyOptionOutput

func (o PriceCurrencyOptionOutput) ToPriceCurrencyOptionOutput() PriceCurrencyOptionOutput

func (PriceCurrencyOptionOutput) ToPriceCurrencyOptionOutputWithContext

func (o PriceCurrencyOptionOutput) ToPriceCurrencyOptionOutputWithContext(ctx context.Context) PriceCurrencyOptionOutput

func (PriceCurrencyOptionOutput) UnitAmount

Int. A positive integer in cents (or 0 for a free price) representing how much to charge.

func (PriceCurrencyOptionOutput) UnitAmountDecimal

func (o PriceCurrencyOptionOutput) UnitAmountDecimal() pulumi.Float64PtrOutput

Float. Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unitAmount and unitAmountDecimal can be set.

type PriceCurrencyOptionTier

type PriceCurrencyOptionTier struct {
	// Int. The flat billing amount for an entire tier, regardless of the number of units in the
	// tier.
	FlatAmount *int `pulumi:"flatAmount"`
	// Float. Same as `flatAmount`, but accepts a decimal value representing an integer
	// in the minor units of the currency. Only one of `flatAmount` and `flatAmountDecimal` can be set.
	FlatAmountDecimal *float64 `pulumi:"flatAmountDecimal"`
	// Int. The per-unit billing amount for each individual unit for which this tier applies.
	UnitAmount *int `pulumi:"unitAmount"`
	// Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.
	UnitAmountDecimal *float64 `pulumi:"unitAmountDecimal"`
	// Int. Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the
	// previous tier adding one. Use `-1` to define a fallback tier.
	UpTo *int `pulumi:"upTo"`
}

type PriceCurrencyOptionTierArgs

type PriceCurrencyOptionTierArgs struct {
	// Int. The flat billing amount for an entire tier, regardless of the number of units in the
	// tier.
	FlatAmount pulumi.IntPtrInput `pulumi:"flatAmount"`
	// Float. Same as `flatAmount`, but accepts a decimal value representing an integer
	// in the minor units of the currency. Only one of `flatAmount` and `flatAmountDecimal` can be set.
	FlatAmountDecimal pulumi.Float64PtrInput `pulumi:"flatAmountDecimal"`
	// Int. The per-unit billing amount for each individual unit for which this tier applies.
	UnitAmount pulumi.IntPtrInput `pulumi:"unitAmount"`
	// Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.
	UnitAmountDecimal pulumi.Float64PtrInput `pulumi:"unitAmountDecimal"`
	// Int. Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the
	// previous tier adding one. Use `-1` to define a fallback tier.
	UpTo pulumi.IntPtrInput `pulumi:"upTo"`
}

func (PriceCurrencyOptionTierArgs) ElementType

func (PriceCurrencyOptionTierArgs) ToPriceCurrencyOptionTierOutput

func (i PriceCurrencyOptionTierArgs) ToPriceCurrencyOptionTierOutput() PriceCurrencyOptionTierOutput

func (PriceCurrencyOptionTierArgs) ToPriceCurrencyOptionTierOutputWithContext

func (i PriceCurrencyOptionTierArgs) ToPriceCurrencyOptionTierOutputWithContext(ctx context.Context) PriceCurrencyOptionTierOutput

type PriceCurrencyOptionTierArray

type PriceCurrencyOptionTierArray []PriceCurrencyOptionTierInput

func (PriceCurrencyOptionTierArray) ElementType

func (PriceCurrencyOptionTierArray) ToPriceCurrencyOptionTierArrayOutput

func (i PriceCurrencyOptionTierArray) ToPriceCurrencyOptionTierArrayOutput() PriceCurrencyOptionTierArrayOutput

func (PriceCurrencyOptionTierArray) ToPriceCurrencyOptionTierArrayOutputWithContext

func (i PriceCurrencyOptionTierArray) ToPriceCurrencyOptionTierArrayOutputWithContext(ctx context.Context) PriceCurrencyOptionTierArrayOutput

type PriceCurrencyOptionTierArrayInput

type PriceCurrencyOptionTierArrayInput interface {
	pulumi.Input

	ToPriceCurrencyOptionTierArrayOutput() PriceCurrencyOptionTierArrayOutput
	ToPriceCurrencyOptionTierArrayOutputWithContext(context.Context) PriceCurrencyOptionTierArrayOutput
}

PriceCurrencyOptionTierArrayInput is an input type that accepts PriceCurrencyOptionTierArray and PriceCurrencyOptionTierArrayOutput values. You can construct a concrete instance of `PriceCurrencyOptionTierArrayInput` via:

PriceCurrencyOptionTierArray{ PriceCurrencyOptionTierArgs{...} }

type PriceCurrencyOptionTierArrayOutput

type PriceCurrencyOptionTierArrayOutput struct{ *pulumi.OutputState }

func (PriceCurrencyOptionTierArrayOutput) ElementType

func (PriceCurrencyOptionTierArrayOutput) Index

func (PriceCurrencyOptionTierArrayOutput) ToPriceCurrencyOptionTierArrayOutput

func (o PriceCurrencyOptionTierArrayOutput) ToPriceCurrencyOptionTierArrayOutput() PriceCurrencyOptionTierArrayOutput

func (PriceCurrencyOptionTierArrayOutput) ToPriceCurrencyOptionTierArrayOutputWithContext

func (o PriceCurrencyOptionTierArrayOutput) ToPriceCurrencyOptionTierArrayOutputWithContext(ctx context.Context) PriceCurrencyOptionTierArrayOutput

type PriceCurrencyOptionTierInput

type PriceCurrencyOptionTierInput interface {
	pulumi.Input

	ToPriceCurrencyOptionTierOutput() PriceCurrencyOptionTierOutput
	ToPriceCurrencyOptionTierOutputWithContext(context.Context) PriceCurrencyOptionTierOutput
}

PriceCurrencyOptionTierInput is an input type that accepts PriceCurrencyOptionTierArgs and PriceCurrencyOptionTierOutput values. You can construct a concrete instance of `PriceCurrencyOptionTierInput` via:

PriceCurrencyOptionTierArgs{...}

type PriceCurrencyOptionTierOutput

type PriceCurrencyOptionTierOutput struct{ *pulumi.OutputState }

func (PriceCurrencyOptionTierOutput) ElementType

func (PriceCurrencyOptionTierOutput) FlatAmount

Int. The flat billing amount for an entire tier, regardless of the number of units in the tier.

func (PriceCurrencyOptionTierOutput) FlatAmountDecimal

Float. Same as `flatAmount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flatAmount` and `flatAmountDecimal` can be set.

func (PriceCurrencyOptionTierOutput) ToPriceCurrencyOptionTierOutput

func (o PriceCurrencyOptionTierOutput) ToPriceCurrencyOptionTierOutput() PriceCurrencyOptionTierOutput

func (PriceCurrencyOptionTierOutput) ToPriceCurrencyOptionTierOutputWithContext

func (o PriceCurrencyOptionTierOutput) ToPriceCurrencyOptionTierOutputWithContext(ctx context.Context) PriceCurrencyOptionTierOutput

func (PriceCurrencyOptionTierOutput) UnitAmount

Int. The per-unit billing amount for each individual unit for which this tier applies.

func (PriceCurrencyOptionTierOutput) UnitAmountDecimal

Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12 decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.

func (PriceCurrencyOptionTierOutput) UpTo

Int. Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `-1` to define a fallback tier.

type PriceInput

type PriceInput interface {
	pulumi.Input

	ToPriceOutput() PriceOutput
	ToPriceOutputWithContext(ctx context.Context) PriceOutput
}

type PriceMap

type PriceMap map[string]PriceInput

func (PriceMap) ElementType

func (PriceMap) ElementType() reflect.Type

func (PriceMap) ToPriceMapOutput

func (i PriceMap) ToPriceMapOutput() PriceMapOutput

func (PriceMap) ToPriceMapOutputWithContext

func (i PriceMap) ToPriceMapOutputWithContext(ctx context.Context) PriceMapOutput

type PriceMapInput

type PriceMapInput interface {
	pulumi.Input

	ToPriceMapOutput() PriceMapOutput
	ToPriceMapOutputWithContext(context.Context) PriceMapOutput
}

PriceMapInput is an input type that accepts PriceMap and PriceMapOutput values. You can construct a concrete instance of `PriceMapInput` via:

PriceMap{ "key": PriceArgs{...} }

type PriceMapOutput

type PriceMapOutput struct{ *pulumi.OutputState }

func (PriceMapOutput) ElementType

func (PriceMapOutput) ElementType() reflect.Type

func (PriceMapOutput) MapIndex

func (PriceMapOutput) ToPriceMapOutput

func (o PriceMapOutput) ToPriceMapOutput() PriceMapOutput

func (PriceMapOutput) ToPriceMapOutputWithContext

func (o PriceMapOutput) ToPriceMapOutputWithContext(ctx context.Context) PriceMapOutput

type PriceOutput

type PriceOutput struct{ *pulumi.OutputState }

func (PriceOutput) Active

func (o PriceOutput) Active() pulumi.BoolPtrOutput

Bool. Whether the price can be used for new purchases. Defaults to `true`.

func (PriceOutput) BillingScheme

func (o PriceOutput) BillingScheme() pulumi.StringPtrOutput

String. Describes how to compute the price per period. Either `perUnit` or `tiered` . `perUnit` indicates that the fixed amount (specified in `unitAmount` or `unitAmountDecimal`) will be charged per unit in quantity (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiersMode` attributes.

func (PriceOutput) Currency

func (o PriceOutput) Currency() pulumi.StringOutput

String. Three-letter ISO currency code, in lowercase - [supported currencies](https://stripe.com/docs/currencies).

func (PriceOutput) CurrencyOptions

func (o PriceOutput) CurrencyOptions() PriceCurrencyOptionArrayOutput

List(Resource). Prices defined in each available currency option. For details of individual arguments see Currency Options.

func (PriceOutput) ElementType

func (PriceOutput) ElementType() reflect.Type

func (PriceOutput) LookupKey

func (o PriceOutput) LookupKey() pulumi.StringPtrOutput

String. A lookup key used to retrieve prices dynamically from a static string.

func (PriceOutput) Metadata

func (o PriceOutput) Metadata() pulumi.StringMapOutput

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

func (PriceOutput) Nickname

func (o PriceOutput) Nickname() pulumi.StringPtrOutput

String. A brief description of the price, hidden from customers.

func (PriceOutput) Product

func (o PriceOutput) Product() pulumi.StringOutput

String. The ID of the product that this price will belong to.

func (PriceOutput) Recurring

func (o PriceOutput) Recurring() PriceRecurringPtrOutput

List(Resource). The recurring components of a price such as `interval` and `usageType`. For details of individual arguments see Recurring.

func (PriceOutput) TaxBehaviour

func (o PriceOutput) TaxBehaviour() pulumi.StringPtrOutput

String. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed, default is `unspecified`.

func (PriceOutput) Tiers

List(Resource). Each element represents a pricing tier. This parameter requires `billingScheme` to be set to `tiered`. See also the documentation for `billingScheme`. For details of individual arguments see Tiers.

func (PriceOutput) TiersMode

func (o PriceOutput) TiersMode() pulumi.StringPtrOutput

String. Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per-unit price, in `graduated` tiering pricing can successively change as the quantity grows.

func (PriceOutput) ToPriceOutput

func (o PriceOutput) ToPriceOutput() PriceOutput

func (PriceOutput) ToPriceOutputWithContext

func (o PriceOutput) ToPriceOutputWithContext(ctx context.Context) PriceOutput

func (PriceOutput) TransferLookupKey

func (o PriceOutput) TransferLookupKey() pulumi.BoolPtrOutput

Bool. If set to `true`, will atomically remove the lookup key from the existing price, and assign it to this price.

func (PriceOutput) TransformQuantity

func (o PriceOutput) TransformQuantity() PriceTransformQuantityPtrOutput

List(Resource). Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with `tiers`. For details of individual arguments see Transform Quantity.

func (PriceOutput) Type

func (o PriceOutput) Type() pulumi.StringOutput

String. One of `oneTime` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

func (PriceOutput) UnitAmount

func (o PriceOutput) UnitAmount() pulumi.IntPtrOutput

Int. A positive integer in cents (or `-1` for a free price) representing how much to charge.

func (PriceOutput) UnitAmountDecimal

func (o PriceOutput) UnitAmountDecimal() pulumi.Float64PtrOutput

Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12 decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.

type PriceRecurring

type PriceRecurring struct {
	// String. Specifies a usage of aggregation strategy for prices of `usage_type=metered`.
	// Allowed values are `sum` for summing up all usage during a period, `lastDuringPeriod` for using the last usage
	// record reported within a period, `lastEver` for using the last usage record ever (across period bounds) or `max`
	// which uses the usage record with the maximum reported usage during a period.
	AggregateUsage *string `pulumi:"aggregateUsage"`
	// String. Specifies billing frequency. Either `day`, `week`, `month` or `year`.
	Interval string `pulumi:"interval"`
	// Int. The number of intervals between subscription billings. For
	// example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year,
	// 12 months, or 52 weeks).
	IntervalCount *int `pulumi:"intervalCount"`
	// String. Configures how the quantity per period should be determined. Can be either `metered`
	// or `licensed`. `licensed` automatically bills the quantity set when adding it to a subscription. `metered` aggregates
	// the total usage based on usage records. Defaults to `licensed`.
	UsageType *string `pulumi:"usageType"`
}

type PriceRecurringArgs

type PriceRecurringArgs struct {
	// String. Specifies a usage of aggregation strategy for prices of `usage_type=metered`.
	// Allowed values are `sum` for summing up all usage during a period, `lastDuringPeriod` for using the last usage
	// record reported within a period, `lastEver` for using the last usage record ever (across period bounds) or `max`
	// which uses the usage record with the maximum reported usage during a period.
	AggregateUsage pulumi.StringPtrInput `pulumi:"aggregateUsage"`
	// String. Specifies billing frequency. Either `day`, `week`, `month` or `year`.
	Interval pulumi.StringInput `pulumi:"interval"`
	// Int. The number of intervals between subscription billings. For
	// example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year,
	// 12 months, or 52 weeks).
	IntervalCount pulumi.IntPtrInput `pulumi:"intervalCount"`
	// String. Configures how the quantity per period should be determined. Can be either `metered`
	// or `licensed`. `licensed` automatically bills the quantity set when adding it to a subscription. `metered` aggregates
	// the total usage based on usage records. Defaults to `licensed`.
	UsageType pulumi.StringPtrInput `pulumi:"usageType"`
}

func (PriceRecurringArgs) ElementType

func (PriceRecurringArgs) ElementType() reflect.Type

func (PriceRecurringArgs) ToPriceRecurringOutput

func (i PriceRecurringArgs) ToPriceRecurringOutput() PriceRecurringOutput

func (PriceRecurringArgs) ToPriceRecurringOutputWithContext

func (i PriceRecurringArgs) ToPriceRecurringOutputWithContext(ctx context.Context) PriceRecurringOutput

func (PriceRecurringArgs) ToPriceRecurringPtrOutput

func (i PriceRecurringArgs) ToPriceRecurringPtrOutput() PriceRecurringPtrOutput

func (PriceRecurringArgs) ToPriceRecurringPtrOutputWithContext

func (i PriceRecurringArgs) ToPriceRecurringPtrOutputWithContext(ctx context.Context) PriceRecurringPtrOutput

type PriceRecurringInput

type PriceRecurringInput interface {
	pulumi.Input

	ToPriceRecurringOutput() PriceRecurringOutput
	ToPriceRecurringOutputWithContext(context.Context) PriceRecurringOutput
}

PriceRecurringInput is an input type that accepts PriceRecurringArgs and PriceRecurringOutput values. You can construct a concrete instance of `PriceRecurringInput` via:

PriceRecurringArgs{...}

type PriceRecurringOutput

type PriceRecurringOutput struct{ *pulumi.OutputState }

func (PriceRecurringOutput) AggregateUsage

func (o PriceRecurringOutput) AggregateUsage() pulumi.StringPtrOutput

String. Specifies a usage of aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `lastDuringPeriod` for using the last usage record reported within a period, `lastEver` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period.

func (PriceRecurringOutput) ElementType

func (PriceRecurringOutput) ElementType() reflect.Type

func (PriceRecurringOutput) Interval

String. Specifies billing frequency. Either `day`, `week`, `month` or `year`.

func (PriceRecurringOutput) IntervalCount

func (o PriceRecurringOutput) IntervalCount() pulumi.IntPtrOutput

Int. The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).

func (PriceRecurringOutput) ToPriceRecurringOutput

func (o PriceRecurringOutput) ToPriceRecurringOutput() PriceRecurringOutput

func (PriceRecurringOutput) ToPriceRecurringOutputWithContext

func (o PriceRecurringOutput) ToPriceRecurringOutputWithContext(ctx context.Context) PriceRecurringOutput

func (PriceRecurringOutput) ToPriceRecurringPtrOutput

func (o PriceRecurringOutput) ToPriceRecurringPtrOutput() PriceRecurringPtrOutput

func (PriceRecurringOutput) ToPriceRecurringPtrOutputWithContext

func (o PriceRecurringOutput) ToPriceRecurringPtrOutputWithContext(ctx context.Context) PriceRecurringPtrOutput

func (PriceRecurringOutput) UsageType

String. Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the quantity set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.

type PriceRecurringPtrInput

type PriceRecurringPtrInput interface {
	pulumi.Input

	ToPriceRecurringPtrOutput() PriceRecurringPtrOutput
	ToPriceRecurringPtrOutputWithContext(context.Context) PriceRecurringPtrOutput
}

PriceRecurringPtrInput is an input type that accepts PriceRecurringArgs, PriceRecurringPtr and PriceRecurringPtrOutput values. You can construct a concrete instance of `PriceRecurringPtrInput` via:

        PriceRecurringArgs{...}

or:

        nil

type PriceRecurringPtrOutput

type PriceRecurringPtrOutput struct{ *pulumi.OutputState }

func (PriceRecurringPtrOutput) AggregateUsage

func (o PriceRecurringPtrOutput) AggregateUsage() pulumi.StringPtrOutput

String. Specifies a usage of aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `lastDuringPeriod` for using the last usage record reported within a period, `lastEver` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period.

func (PriceRecurringPtrOutput) Elem

func (PriceRecurringPtrOutput) ElementType

func (PriceRecurringPtrOutput) ElementType() reflect.Type

func (PriceRecurringPtrOutput) Interval

String. Specifies billing frequency. Either `day`, `week`, `month` or `year`.

func (PriceRecurringPtrOutput) IntervalCount

func (o PriceRecurringPtrOutput) IntervalCount() pulumi.IntPtrOutput

Int. The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).

func (PriceRecurringPtrOutput) ToPriceRecurringPtrOutput

func (o PriceRecurringPtrOutput) ToPriceRecurringPtrOutput() PriceRecurringPtrOutput

func (PriceRecurringPtrOutput) ToPriceRecurringPtrOutputWithContext

func (o PriceRecurringPtrOutput) ToPriceRecurringPtrOutputWithContext(ctx context.Context) PriceRecurringPtrOutput

func (PriceRecurringPtrOutput) UsageType

String. Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the quantity set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.

type PriceState

type PriceState struct {
	// Bool. Whether the price can be used for new purchases. Defaults to `true`.
	Active pulumi.BoolPtrInput
	// String. Describes how to compute the price per period. Either `perUnit` or `tiered`
	// . `perUnit` indicates that the fixed amount (specified in `unitAmount` or `unitAmountDecimal`) will be charged per
	// unit in quantity (for prices with `usage_type=licensed`), or per unit of total usage (for prices
	// with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as
	// defined using the `tiers` and `tiersMode` attributes.
	BillingScheme pulumi.StringPtrInput
	// String. Three-letter ISO currency code, in lowercase - [supported currencies](https://stripe.com/docs/currencies).
	Currency pulumi.StringPtrInput
	// List(Resource). Prices defined in each available currency option. For details
	// of individual arguments see Currency Options.
	CurrencyOptions PriceCurrencyOptionArrayInput
	// String. A lookup key used to retrieve prices dynamically from a static string.
	LookupKey pulumi.StringPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for
	// storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. A brief description of the price, hidden from customers.
	Nickname pulumi.StringPtrInput
	// String. The ID of the product that this price will belong to.
	Product pulumi.StringPtrInput
	// List(Resource). The recurring components of a price such as `interval` and `usageType`. For
	// details of individual arguments see Recurring.
	Recurring PriceRecurringPtrInput
	// String. Specifies whether the price is considered inclusive of taxes or exclusive of
	// taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it
	// cannot be changed, default is `unspecified`.
	TaxBehaviour pulumi.StringPtrInput
	// List(Resource). Each element represents a pricing tier. This parameter requires `billingScheme`
	// to be set to `tiered`. See also the documentation for `billingScheme`. For details of individual arguments
	// see Tiers.
	Tiers PriceTierArrayInput
	// String. Defines if the tiering price should be `graduated`
	// or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per-unit price,
	// in `graduated` tiering pricing can successively change as the quantity grows.
	TiersMode pulumi.StringPtrInput
	// Bool. If set to `true`, will atomically remove the lookup key from the existing
	// price, and assign it to this price.
	TransferLookupKey pulumi.BoolPtrInput
	// List(Resource). Apply a transformation to the reported usage or set quantity before
	// computing the billed price. Cannot be combined with `tiers`. For details of individual arguments
	// see Transform Quantity.
	TransformQuantity PriceTransformQuantityPtrInput
	// String. One of `oneTime` or `recurring` depending on whether the price is for a one-time purchase or a
	// recurring (subscription) purchase.
	Type pulumi.StringPtrInput
	// Int. A positive integer in cents (or `-1` for a free
	// price) representing how much to charge.
	UnitAmount pulumi.IntPtrInput
	// Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.
	UnitAmountDecimal pulumi.Float64PtrInput
}

func (PriceState) ElementType

func (PriceState) ElementType() reflect.Type

type PriceTier

type PriceTier struct {
	// Int. The flat billing amount for an entire tier, regardless of the number of units in the
	// tier.
	FlatAmount *int `pulumi:"flatAmount"`
	// Float. Same as `flatAmount`, but accepts a decimal value representing an integer
	// in the minor units of the currency. Only one of `flatAmount` and `flatAmountDecimal` can be set.
	FlatAmountDecimal *float64 `pulumi:"flatAmountDecimal"`
	// Int. The per-unit billing amount for each individual unit for which this tier applies.
	UnitAmount *int `pulumi:"unitAmount"`
	// Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.
	UnitAmountDecimal *float64 `pulumi:"unitAmountDecimal"`
	// Int. Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the
	// previous tier adding one. Use `-1` to define a fallback tier.
	UpTo *int `pulumi:"upTo"`
}

type PriceTierArgs

type PriceTierArgs struct {
	// Int. The flat billing amount for an entire tier, regardless of the number of units in the
	// tier.
	FlatAmount pulumi.IntPtrInput `pulumi:"flatAmount"`
	// Float. Same as `flatAmount`, but accepts a decimal value representing an integer
	// in the minor units of the currency. Only one of `flatAmount` and `flatAmountDecimal` can be set.
	FlatAmountDecimal pulumi.Float64PtrInput `pulumi:"flatAmountDecimal"`
	// Int. The per-unit billing amount for each individual unit for which this tier applies.
	UnitAmount pulumi.IntPtrInput `pulumi:"unitAmount"`
	// Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12
	// decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.
	UnitAmountDecimal pulumi.Float64PtrInput `pulumi:"unitAmountDecimal"`
	// Int. Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the
	// previous tier adding one. Use `-1` to define a fallback tier.
	UpTo pulumi.IntPtrInput `pulumi:"upTo"`
}

func (PriceTierArgs) ElementType

func (PriceTierArgs) ElementType() reflect.Type

func (PriceTierArgs) ToPriceTierOutput

func (i PriceTierArgs) ToPriceTierOutput() PriceTierOutput

func (PriceTierArgs) ToPriceTierOutputWithContext

func (i PriceTierArgs) ToPriceTierOutputWithContext(ctx context.Context) PriceTierOutput

type PriceTierArray

type PriceTierArray []PriceTierInput

func (PriceTierArray) ElementType

func (PriceTierArray) ElementType() reflect.Type

func (PriceTierArray) ToPriceTierArrayOutput

func (i PriceTierArray) ToPriceTierArrayOutput() PriceTierArrayOutput

func (PriceTierArray) ToPriceTierArrayOutputWithContext

func (i PriceTierArray) ToPriceTierArrayOutputWithContext(ctx context.Context) PriceTierArrayOutput

type PriceTierArrayInput

type PriceTierArrayInput interface {
	pulumi.Input

	ToPriceTierArrayOutput() PriceTierArrayOutput
	ToPriceTierArrayOutputWithContext(context.Context) PriceTierArrayOutput
}

PriceTierArrayInput is an input type that accepts PriceTierArray and PriceTierArrayOutput values. You can construct a concrete instance of `PriceTierArrayInput` via:

PriceTierArray{ PriceTierArgs{...} }

type PriceTierArrayOutput

type PriceTierArrayOutput struct{ *pulumi.OutputState }

func (PriceTierArrayOutput) ElementType

func (PriceTierArrayOutput) ElementType() reflect.Type

func (PriceTierArrayOutput) Index

func (PriceTierArrayOutput) ToPriceTierArrayOutput

func (o PriceTierArrayOutput) ToPriceTierArrayOutput() PriceTierArrayOutput

func (PriceTierArrayOutput) ToPriceTierArrayOutputWithContext

func (o PriceTierArrayOutput) ToPriceTierArrayOutputWithContext(ctx context.Context) PriceTierArrayOutput

type PriceTierInput

type PriceTierInput interface {
	pulumi.Input

	ToPriceTierOutput() PriceTierOutput
	ToPriceTierOutputWithContext(context.Context) PriceTierOutput
}

PriceTierInput is an input type that accepts PriceTierArgs and PriceTierOutput values. You can construct a concrete instance of `PriceTierInput` via:

PriceTierArgs{...}

type PriceTierOutput

type PriceTierOutput struct{ *pulumi.OutputState }

func (PriceTierOutput) ElementType

func (PriceTierOutput) ElementType() reflect.Type

func (PriceTierOutput) FlatAmount

func (o PriceTierOutput) FlatAmount() pulumi.IntPtrOutput

Int. The flat billing amount for an entire tier, regardless of the number of units in the tier.

func (PriceTierOutput) FlatAmountDecimal

func (o PriceTierOutput) FlatAmountDecimal() pulumi.Float64PtrOutput

Float. Same as `flatAmount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flatAmount` and `flatAmountDecimal` can be set.

func (PriceTierOutput) ToPriceTierOutput

func (o PriceTierOutput) ToPriceTierOutput() PriceTierOutput

func (PriceTierOutput) ToPriceTierOutputWithContext

func (o PriceTierOutput) ToPriceTierOutputWithContext(ctx context.Context) PriceTierOutput

func (PriceTierOutput) UnitAmount

func (o PriceTierOutput) UnitAmount() pulumi.IntPtrOutput

Int. The per-unit billing amount for each individual unit for which this tier applies.

func (PriceTierOutput) UnitAmountDecimal

func (o PriceTierOutput) UnitAmountDecimal() pulumi.Float64PtrOutput

Float. Same as `unitAmount`, but accepts a decimal value in cents with at most 12 decimal places. Only one of `unitAmount` and `unitAmountDecimal` can be set.

func (PriceTierOutput) UpTo

Int. Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `-1` to define a fallback tier.

type PriceTransformQuantity

type PriceTransformQuantity struct {
	// Int. Divide usage by this number.
	DivideBy int `pulumi:"divideBy"`
	// String. After division, either round the result `up` or `down`.
	Round string `pulumi:"round"`
}

type PriceTransformQuantityArgs

type PriceTransformQuantityArgs struct {
	// Int. Divide usage by this number.
	DivideBy pulumi.IntInput `pulumi:"divideBy"`
	// String. After division, either round the result `up` or `down`.
	Round pulumi.StringInput `pulumi:"round"`
}

func (PriceTransformQuantityArgs) ElementType

func (PriceTransformQuantityArgs) ElementType() reflect.Type

func (PriceTransformQuantityArgs) ToPriceTransformQuantityOutput

func (i PriceTransformQuantityArgs) ToPriceTransformQuantityOutput() PriceTransformQuantityOutput

func (PriceTransformQuantityArgs) ToPriceTransformQuantityOutputWithContext

func (i PriceTransformQuantityArgs) ToPriceTransformQuantityOutputWithContext(ctx context.Context) PriceTransformQuantityOutput

func (PriceTransformQuantityArgs) ToPriceTransformQuantityPtrOutput

func (i PriceTransformQuantityArgs) ToPriceTransformQuantityPtrOutput() PriceTransformQuantityPtrOutput

func (PriceTransformQuantityArgs) ToPriceTransformQuantityPtrOutputWithContext

func (i PriceTransformQuantityArgs) ToPriceTransformQuantityPtrOutputWithContext(ctx context.Context) PriceTransformQuantityPtrOutput

type PriceTransformQuantityInput

type PriceTransformQuantityInput interface {
	pulumi.Input

	ToPriceTransformQuantityOutput() PriceTransformQuantityOutput
	ToPriceTransformQuantityOutputWithContext(context.Context) PriceTransformQuantityOutput
}

PriceTransformQuantityInput is an input type that accepts PriceTransformQuantityArgs and PriceTransformQuantityOutput values. You can construct a concrete instance of `PriceTransformQuantityInput` via:

PriceTransformQuantityArgs{...}

type PriceTransformQuantityOutput

type PriceTransformQuantityOutput struct{ *pulumi.OutputState }

func (PriceTransformQuantityOutput) DivideBy

Int. Divide usage by this number.

func (PriceTransformQuantityOutput) ElementType

func (PriceTransformQuantityOutput) Round

String. After division, either round the result `up` or `down`.

func (PriceTransformQuantityOutput) ToPriceTransformQuantityOutput

func (o PriceTransformQuantityOutput) ToPriceTransformQuantityOutput() PriceTransformQuantityOutput

func (PriceTransformQuantityOutput) ToPriceTransformQuantityOutputWithContext

func (o PriceTransformQuantityOutput) ToPriceTransformQuantityOutputWithContext(ctx context.Context) PriceTransformQuantityOutput

func (PriceTransformQuantityOutput) ToPriceTransformQuantityPtrOutput

func (o PriceTransformQuantityOutput) ToPriceTransformQuantityPtrOutput() PriceTransformQuantityPtrOutput

func (PriceTransformQuantityOutput) ToPriceTransformQuantityPtrOutputWithContext

func (o PriceTransformQuantityOutput) ToPriceTransformQuantityPtrOutputWithContext(ctx context.Context) PriceTransformQuantityPtrOutput

type PriceTransformQuantityPtrInput

type PriceTransformQuantityPtrInput interface {
	pulumi.Input

	ToPriceTransformQuantityPtrOutput() PriceTransformQuantityPtrOutput
	ToPriceTransformQuantityPtrOutputWithContext(context.Context) PriceTransformQuantityPtrOutput
}

PriceTransformQuantityPtrInput is an input type that accepts PriceTransformQuantityArgs, PriceTransformQuantityPtr and PriceTransformQuantityPtrOutput values. You can construct a concrete instance of `PriceTransformQuantityPtrInput` via:

        PriceTransformQuantityArgs{...}

or:

        nil

type PriceTransformQuantityPtrOutput

type PriceTransformQuantityPtrOutput struct{ *pulumi.OutputState }

func (PriceTransformQuantityPtrOutput) DivideBy

Int. Divide usage by this number.

func (PriceTransformQuantityPtrOutput) Elem

func (PriceTransformQuantityPtrOutput) ElementType

func (PriceTransformQuantityPtrOutput) Round

String. After division, either round the result `up` or `down`.

func (PriceTransformQuantityPtrOutput) ToPriceTransformQuantityPtrOutput

func (o PriceTransformQuantityPtrOutput) ToPriceTransformQuantityPtrOutput() PriceTransformQuantityPtrOutput

func (PriceTransformQuantityPtrOutput) ToPriceTransformQuantityPtrOutputWithContext

func (o PriceTransformQuantityPtrOutput) ToPriceTransformQuantityPtrOutputWithContext(ctx context.Context) PriceTransformQuantityPtrOutput

type Product

type Product struct {
	pulumi.CustomResourceState

	// Bool. Whether the product is currently available for purchase. Defaults to `true`.
	Active pulumi.BoolPtrOutput `pulumi:"active"`
	// String. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// List(String). A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
	Images pulumi.StringArrayOutput `pulumi:"images"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// String. The product’s name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
	Name pulumi.StringOutput `pulumi:"name"`
	// Map(Float). The dimensions of this product for shipping purposes. When used these fields are required: `height`,`length`,`width` and `weight`; the precision is 2 decimal places.
	PackageDimensions pulumi.Float64MapOutput `pulumi:"packageDimensions"`
	// String. The bespoke unique identifier for the object.
	ProductId pulumi.StringOutput `pulumi:"productId"`
	// Bool. Whether this product is shipped (i.e., physical goods).
	Shippable pulumi.BoolPtrOutput `pulumi:"shippable"`
	// String. An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`,`  > `, `\`, `"`, `’` characters, and will appear on your customer’s statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter.
	StatementDescriptor pulumi.StringPtrOutput `pulumi:"statementDescriptor"`
	// String. A tax code ID. Supported values are listed in the TaxCode resource and at https://stripe.com/docs/tax/tax-categories.
	TaxCode pulumi.StringPtrOutput `pulumi:"taxCode"`
	// String. A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
	UnitLabel pulumi.StringPtrOutput `pulumi:"unitLabel"`
	// String. A URL of a publicly-accessible webpage for this product.
	Url pulumi.StringPtrOutput `pulumi:"url"`
}

With this resource, you can create a product - [Stripe API product documentation](https://stripe.com/docs/api/products).

Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.

## Example Usage

```go package main

import (

"github.com/georgegebbett/pulumi-stripe/sdk/go/stripe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stripe.NewProduct(ctx, "product", &stripe.ProductArgs{
			Description: pulumi.String("fantastic product"),
			UnitLabel:   pulumi.String("piece"),
			Url:         pulumi.String("https://www.terraform.io"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetProduct

func GetProduct(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ProductState, opts ...pulumi.ResourceOption) (*Product, error)

GetProduct gets an existing Product resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewProduct

func NewProduct(ctx *pulumi.Context,
	name string, args *ProductArgs, opts ...pulumi.ResourceOption) (*Product, error)

NewProduct registers a new resource with the given unique name, arguments, and options.

func (*Product) ElementType

func (*Product) ElementType() reflect.Type

func (*Product) ToProductOutput

func (i *Product) ToProductOutput() ProductOutput

func (*Product) ToProductOutputWithContext

func (i *Product) ToProductOutputWithContext(ctx context.Context) ProductOutput

type ProductArgs

type ProductArgs struct {
	// Bool. Whether the product is currently available for purchase. Defaults to `true`.
	Active pulumi.BoolPtrInput
	// String. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
	Description pulumi.StringPtrInput
	// List(String). A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
	Images pulumi.StringArrayInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. The product’s name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
	Name pulumi.StringPtrInput
	// Map(Float). The dimensions of this product for shipping purposes. When used these fields are required: `height`,`length`,`width` and `weight`; the precision is 2 decimal places.
	PackageDimensions pulumi.Float64MapInput
	// String. The bespoke unique identifier for the object.
	ProductId pulumi.StringPtrInput
	// Bool. Whether this product is shipped (i.e., physical goods).
	Shippable pulumi.BoolPtrInput
	// String. An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`,`  > `, `\`, `"`, `’` characters, and will appear on your customer’s statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter.
	StatementDescriptor pulumi.StringPtrInput
	// String. A tax code ID. Supported values are listed in the TaxCode resource and at https://stripe.com/docs/tax/tax-categories.
	TaxCode pulumi.StringPtrInput
	// String. A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
	UnitLabel pulumi.StringPtrInput
	// String. A URL of a publicly-accessible webpage for this product.
	Url pulumi.StringPtrInput
}

The set of arguments for constructing a Product resource.

func (ProductArgs) ElementType

func (ProductArgs) ElementType() reflect.Type

type ProductArray

type ProductArray []ProductInput

func (ProductArray) ElementType

func (ProductArray) ElementType() reflect.Type

func (ProductArray) ToProductArrayOutput

func (i ProductArray) ToProductArrayOutput() ProductArrayOutput

func (ProductArray) ToProductArrayOutputWithContext

func (i ProductArray) ToProductArrayOutputWithContext(ctx context.Context) ProductArrayOutput

type ProductArrayInput

type ProductArrayInput interface {
	pulumi.Input

	ToProductArrayOutput() ProductArrayOutput
	ToProductArrayOutputWithContext(context.Context) ProductArrayOutput
}

ProductArrayInput is an input type that accepts ProductArray and ProductArrayOutput values. You can construct a concrete instance of `ProductArrayInput` via:

ProductArray{ ProductArgs{...} }

type ProductArrayOutput

type ProductArrayOutput struct{ *pulumi.OutputState }

func (ProductArrayOutput) ElementType

func (ProductArrayOutput) ElementType() reflect.Type

func (ProductArrayOutput) Index

func (ProductArrayOutput) ToProductArrayOutput

func (o ProductArrayOutput) ToProductArrayOutput() ProductArrayOutput

func (ProductArrayOutput) ToProductArrayOutputWithContext

func (o ProductArrayOutput) ToProductArrayOutputWithContext(ctx context.Context) ProductArrayOutput

type ProductInput

type ProductInput interface {
	pulumi.Input

	ToProductOutput() ProductOutput
	ToProductOutputWithContext(ctx context.Context) ProductOutput
}

type ProductMap

type ProductMap map[string]ProductInput

func (ProductMap) ElementType

func (ProductMap) ElementType() reflect.Type

func (ProductMap) ToProductMapOutput

func (i ProductMap) ToProductMapOutput() ProductMapOutput

func (ProductMap) ToProductMapOutputWithContext

func (i ProductMap) ToProductMapOutputWithContext(ctx context.Context) ProductMapOutput

type ProductMapInput

type ProductMapInput interface {
	pulumi.Input

	ToProductMapOutput() ProductMapOutput
	ToProductMapOutputWithContext(context.Context) ProductMapOutput
}

ProductMapInput is an input type that accepts ProductMap and ProductMapOutput values. You can construct a concrete instance of `ProductMapInput` via:

ProductMap{ "key": ProductArgs{...} }

type ProductMapOutput

type ProductMapOutput struct{ *pulumi.OutputState }

func (ProductMapOutput) ElementType

func (ProductMapOutput) ElementType() reflect.Type

func (ProductMapOutput) MapIndex

func (ProductMapOutput) ToProductMapOutput

func (o ProductMapOutput) ToProductMapOutput() ProductMapOutput

func (ProductMapOutput) ToProductMapOutputWithContext

func (o ProductMapOutput) ToProductMapOutputWithContext(ctx context.Context) ProductMapOutput

type ProductOutput

type ProductOutput struct{ *pulumi.OutputState }

func (ProductOutput) Active

func (o ProductOutput) Active() pulumi.BoolPtrOutput

Bool. Whether the product is currently available for purchase. Defaults to `true`.

func (ProductOutput) Description

func (o ProductOutput) Description() pulumi.StringPtrOutput

String. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

func (ProductOutput) ElementType

func (ProductOutput) ElementType() reflect.Type

func (ProductOutput) Images

List(String). A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

func (ProductOutput) Metadata

func (o ProductOutput) Metadata() pulumi.StringMapOutput

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

func (ProductOutput) Name

String. The product’s name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.

func (ProductOutput) PackageDimensions

func (o ProductOutput) PackageDimensions() pulumi.Float64MapOutput

Map(Float). The dimensions of this product for shipping purposes. When used these fields are required: `height`,`length`,`width` and `weight`; the precision is 2 decimal places.

func (ProductOutput) ProductId

func (o ProductOutput) ProductId() pulumi.StringOutput

String. The bespoke unique identifier for the object.

func (ProductOutput) Shippable

func (o ProductOutput) Shippable() pulumi.BoolPtrOutput

Bool. Whether this product is shipped (i.e., physical goods).

func (ProductOutput) StatementDescriptor

func (o ProductOutput) StatementDescriptor() pulumi.StringPtrOutput

String. An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`,` > `, `\`, `"`, `’` characters, and will appear on your customer’s statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter.

func (ProductOutput) TaxCode

func (o ProductOutput) TaxCode() pulumi.StringPtrOutput

String. A tax code ID. Supported values are listed in the TaxCode resource and at https://stripe.com/docs/tax/tax-categories.

func (ProductOutput) ToProductOutput

func (o ProductOutput) ToProductOutput() ProductOutput

func (ProductOutput) ToProductOutputWithContext

func (o ProductOutput) ToProductOutputWithContext(ctx context.Context) ProductOutput

func (ProductOutput) UnitLabel

func (o ProductOutput) UnitLabel() pulumi.StringPtrOutput

String. A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.

func (ProductOutput) Url

String. A URL of a publicly-accessible webpage for this product.

type ProductState

type ProductState struct {
	// Bool. Whether the product is currently available for purchase. Defaults to `true`.
	Active pulumi.BoolPtrInput
	// String. The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
	Description pulumi.StringPtrInput
	// List(String). A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
	Images pulumi.StringArrayInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. The product’s name, meant to be displayable to the customer. Whenever this product is sold via a subscription, name will show up on associated invoice line item descriptions.
	Name pulumi.StringPtrInput
	// Map(Float). The dimensions of this product for shipping purposes. When used these fields are required: `height`,`length`,`width` and `weight`; the precision is 2 decimal places.
	PackageDimensions pulumi.Float64MapInput
	// String. The bespoke unique identifier for the object.
	ProductId pulumi.StringPtrInput
	// Bool. Whether this product is shipped (i.e., physical goods).
	Shippable pulumi.BoolPtrInput
	// String. An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters. The statement description may not include `<`,`  > `, `\`, `"`, `’` characters, and will appear on your customer’s statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter.
	StatementDescriptor pulumi.StringPtrInput
	// String. A tax code ID. Supported values are listed in the TaxCode resource and at https://stripe.com/docs/tax/tax-categories.
	TaxCode pulumi.StringPtrInput
	// String. A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.
	UnitLabel pulumi.StringPtrInput
	// String. A URL of a publicly-accessible webpage for this product.
	Url pulumi.StringPtrInput
}

func (ProductState) ElementType

func (ProductState) ElementType() reflect.Type

type PromotionCode

type PromotionCode struct {
	pulumi.CustomResourceState

	// Bool. Whether the promotion code is currently active. Defaults to `true`.
	Active pulumi.BoolPtrOutput `pulumi:"active"`
	// String. The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.
	Code pulumi.StringPtrOutput `pulumi:"code"`
	// String. The coupon for this promotion code.
	Coupon pulumi.StringOutput `pulumi:"coupon"`
	// String. The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
	Customer pulumi.StringPtrOutput `pulumi:"customer"`
	// String. The timestamp at which this promotion code will expire. If the coupon has specified a `redeemsBy`, then this value cannot be after the coupon’s `redeemsBy`. Expected format is `RFC3339`.
	ExpiresAt pulumi.StringPtrOutput `pulumi:"expiresAt"`
	// Int. A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `maxRedemptions`, then this value cannot be greater than the coupon’s `maxRedemptions`.
	MaxRedemptions pulumi.IntPtrOutput `pulumi:"maxRedemptions"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// List(Resource). Settings that restrict the redemption of the promotion code. For details of individual arguments see Restrictions.
	Restrictions PromotionCodeRestrictionsPtrOutput `pulumi:"restrictions"`
}

With this resource, you can create a promotion code - [Stripe API promotion code documentation](https://stripe.com/docs/api/promotion_codes).

A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.

> Removal of the promotion code isn't supported through the Stripe SDK.

## Example Usage

```go package main

import (

"github.com/georgegebbett/pulumi-stripe/sdk/go/stripe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stripe.NewPromotionCode(ctx, "codePromotionCode", &stripe.PromotionCodeArgs{
			Coupon: pulumi.Any(stripe_coupon.Coupon.Id),
			Code:   pulumi.String("FREE"),
		})
		if err != nil {
			return err
		}
		_, err = stripe.NewPromotionCode(ctx, "codeIndex/promotionCodePromotionCode", &stripe.PromotionCodeArgs{
			Coupon:         pulumi.Any(stripe_coupon.Coupon.Id),
			Code:           pulumi.String("FREE"),
			MaxRedemptions: pulumi.Int(5),
			ExpiresAt:      pulumi.String("2025-08-03T08:37:18+00:00"),
		})
		if err != nil {
			return err
		}
		_, err = stripe.NewPromotionCode(ctx, "codeStripeIndex/promotionCodePromotionCode", &stripe.PromotionCodeArgs{
			Coupon:   pulumi.Any(stripe_coupon.Coupon.Id),
			Code:     pulumi.String("FREE"),
			Customer: pulumi.String("cus..."),
		})
		if err != nil {
			return err
		}
		_, err = stripe.NewPromotionCode(ctx, "codeStripeIndex/promotionCodePromotionCode1", &stripe.PromotionCodeArgs{
			Coupon: pulumi.Any(stripe_coupon.Coupon.Id),
			Code:   pulumi.String("FREE"),
			Restrictions: &stripe.PromotionCodeRestrictionsArgs{
				FirstTimeTransaction:  pulumi.Bool(true),
				MinimumAmount:         pulumi.Int(100),
				MinimumAmountCurrency: pulumi.String("aud"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetPromotionCode

func GetPromotionCode(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PromotionCodeState, opts ...pulumi.ResourceOption) (*PromotionCode, error)

GetPromotionCode gets an existing PromotionCode resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPromotionCode

func NewPromotionCode(ctx *pulumi.Context,
	name string, args *PromotionCodeArgs, opts ...pulumi.ResourceOption) (*PromotionCode, error)

NewPromotionCode registers a new resource with the given unique name, arguments, and options.

func (*PromotionCode) ElementType

func (*PromotionCode) ElementType() reflect.Type

func (*PromotionCode) ToPromotionCodeOutput

func (i *PromotionCode) ToPromotionCodeOutput() PromotionCodeOutput

func (*PromotionCode) ToPromotionCodeOutputWithContext

func (i *PromotionCode) ToPromotionCodeOutputWithContext(ctx context.Context) PromotionCodeOutput

type PromotionCodeArgs

type PromotionCodeArgs struct {
	// Bool. Whether the promotion code is currently active. Defaults to `true`.
	Active pulumi.BoolPtrInput
	// String. The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.
	Code pulumi.StringPtrInput
	// String. The coupon for this promotion code.
	Coupon pulumi.StringInput
	// String. The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
	Customer pulumi.StringPtrInput
	// String. The timestamp at which this promotion code will expire. If the coupon has specified a `redeemsBy`, then this value cannot be after the coupon’s `redeemsBy`. Expected format is `RFC3339`.
	ExpiresAt pulumi.StringPtrInput
	// Int. A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `maxRedemptions`, then this value cannot be greater than the coupon’s `maxRedemptions`.
	MaxRedemptions pulumi.IntPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// List(Resource). Settings that restrict the redemption of the promotion code. For details of individual arguments see Restrictions.
	Restrictions PromotionCodeRestrictionsPtrInput
}

The set of arguments for constructing a PromotionCode resource.

func (PromotionCodeArgs) ElementType

func (PromotionCodeArgs) ElementType() reflect.Type

type PromotionCodeArray

type PromotionCodeArray []PromotionCodeInput

func (PromotionCodeArray) ElementType

func (PromotionCodeArray) ElementType() reflect.Type

func (PromotionCodeArray) ToPromotionCodeArrayOutput

func (i PromotionCodeArray) ToPromotionCodeArrayOutput() PromotionCodeArrayOutput

func (PromotionCodeArray) ToPromotionCodeArrayOutputWithContext

func (i PromotionCodeArray) ToPromotionCodeArrayOutputWithContext(ctx context.Context) PromotionCodeArrayOutput

type PromotionCodeArrayInput

type PromotionCodeArrayInput interface {
	pulumi.Input

	ToPromotionCodeArrayOutput() PromotionCodeArrayOutput
	ToPromotionCodeArrayOutputWithContext(context.Context) PromotionCodeArrayOutput
}

PromotionCodeArrayInput is an input type that accepts PromotionCodeArray and PromotionCodeArrayOutput values. You can construct a concrete instance of `PromotionCodeArrayInput` via:

PromotionCodeArray{ PromotionCodeArgs{...} }

type PromotionCodeArrayOutput

type PromotionCodeArrayOutput struct{ *pulumi.OutputState }

func (PromotionCodeArrayOutput) ElementType

func (PromotionCodeArrayOutput) ElementType() reflect.Type

func (PromotionCodeArrayOutput) Index

func (PromotionCodeArrayOutput) ToPromotionCodeArrayOutput

func (o PromotionCodeArrayOutput) ToPromotionCodeArrayOutput() PromotionCodeArrayOutput

func (PromotionCodeArrayOutput) ToPromotionCodeArrayOutputWithContext

func (o PromotionCodeArrayOutput) ToPromotionCodeArrayOutputWithContext(ctx context.Context) PromotionCodeArrayOutput

type PromotionCodeInput

type PromotionCodeInput interface {
	pulumi.Input

	ToPromotionCodeOutput() PromotionCodeOutput
	ToPromotionCodeOutputWithContext(ctx context.Context) PromotionCodeOutput
}

type PromotionCodeMap

type PromotionCodeMap map[string]PromotionCodeInput

func (PromotionCodeMap) ElementType

func (PromotionCodeMap) ElementType() reflect.Type

func (PromotionCodeMap) ToPromotionCodeMapOutput

func (i PromotionCodeMap) ToPromotionCodeMapOutput() PromotionCodeMapOutput

func (PromotionCodeMap) ToPromotionCodeMapOutputWithContext

func (i PromotionCodeMap) ToPromotionCodeMapOutputWithContext(ctx context.Context) PromotionCodeMapOutput

type PromotionCodeMapInput

type PromotionCodeMapInput interface {
	pulumi.Input

	ToPromotionCodeMapOutput() PromotionCodeMapOutput
	ToPromotionCodeMapOutputWithContext(context.Context) PromotionCodeMapOutput
}

PromotionCodeMapInput is an input type that accepts PromotionCodeMap and PromotionCodeMapOutput values. You can construct a concrete instance of `PromotionCodeMapInput` via:

PromotionCodeMap{ "key": PromotionCodeArgs{...} }

type PromotionCodeMapOutput

type PromotionCodeMapOutput struct{ *pulumi.OutputState }

func (PromotionCodeMapOutput) ElementType

func (PromotionCodeMapOutput) ElementType() reflect.Type

func (PromotionCodeMapOutput) MapIndex

func (PromotionCodeMapOutput) ToPromotionCodeMapOutput

func (o PromotionCodeMapOutput) ToPromotionCodeMapOutput() PromotionCodeMapOutput

func (PromotionCodeMapOutput) ToPromotionCodeMapOutputWithContext

func (o PromotionCodeMapOutput) ToPromotionCodeMapOutputWithContext(ctx context.Context) PromotionCodeMapOutput

type PromotionCodeOutput

type PromotionCodeOutput struct{ *pulumi.OutputState }

func (PromotionCodeOutput) Active

Bool. Whether the promotion code is currently active. Defaults to `true`.

func (PromotionCodeOutput) Code

String. The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.

func (PromotionCodeOutput) Coupon

String. The coupon for this promotion code.

func (PromotionCodeOutput) Customer

String. The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.

func (PromotionCodeOutput) ElementType

func (PromotionCodeOutput) ElementType() reflect.Type

func (PromotionCodeOutput) ExpiresAt

String. The timestamp at which this promotion code will expire. If the coupon has specified a `redeemsBy`, then this value cannot be after the coupon’s `redeemsBy`. Expected format is `RFC3339`.

func (PromotionCodeOutput) MaxRedemptions

func (o PromotionCodeOutput) MaxRedemptions() pulumi.IntPtrOutput

Int. A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `maxRedemptions`, then this value cannot be greater than the coupon’s `maxRedemptions`.

func (PromotionCodeOutput) Metadata

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

func (PromotionCodeOutput) Restrictions

List(Resource). Settings that restrict the redemption of the promotion code. For details of individual arguments see Restrictions.

func (PromotionCodeOutput) ToPromotionCodeOutput

func (o PromotionCodeOutput) ToPromotionCodeOutput() PromotionCodeOutput

func (PromotionCodeOutput) ToPromotionCodeOutputWithContext

func (o PromotionCodeOutput) ToPromotionCodeOutputWithContext(ctx context.Context) PromotionCodeOutput

type PromotionCodeRestrictions

type PromotionCodeRestrictions struct {
	// Bool. A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices.
	FirstTimeTransaction bool `pulumi:"firstTimeTransaction"`
	// Int. Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
	MinimumAmount int `pulumi:"minimumAmount"`
	// String. Three-letter ISO code for `minimumAmount`.
	MinimumAmountCurrency string `pulumi:"minimumAmountCurrency"`
}

type PromotionCodeRestrictionsArgs

type PromotionCodeRestrictionsArgs struct {
	// Bool. A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices.
	FirstTimeTransaction pulumi.BoolInput `pulumi:"firstTimeTransaction"`
	// Int. Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
	MinimumAmount pulumi.IntInput `pulumi:"minimumAmount"`
	// String. Three-letter ISO code for `minimumAmount`.
	MinimumAmountCurrency pulumi.StringInput `pulumi:"minimumAmountCurrency"`
}

func (PromotionCodeRestrictionsArgs) ElementType

func (PromotionCodeRestrictionsArgs) ToPromotionCodeRestrictionsOutput

func (i PromotionCodeRestrictionsArgs) ToPromotionCodeRestrictionsOutput() PromotionCodeRestrictionsOutput

func (PromotionCodeRestrictionsArgs) ToPromotionCodeRestrictionsOutputWithContext

func (i PromotionCodeRestrictionsArgs) ToPromotionCodeRestrictionsOutputWithContext(ctx context.Context) PromotionCodeRestrictionsOutput

func (PromotionCodeRestrictionsArgs) ToPromotionCodeRestrictionsPtrOutput

func (i PromotionCodeRestrictionsArgs) ToPromotionCodeRestrictionsPtrOutput() PromotionCodeRestrictionsPtrOutput

func (PromotionCodeRestrictionsArgs) ToPromotionCodeRestrictionsPtrOutputWithContext

func (i PromotionCodeRestrictionsArgs) ToPromotionCodeRestrictionsPtrOutputWithContext(ctx context.Context) PromotionCodeRestrictionsPtrOutput

type PromotionCodeRestrictionsInput

type PromotionCodeRestrictionsInput interface {
	pulumi.Input

	ToPromotionCodeRestrictionsOutput() PromotionCodeRestrictionsOutput
	ToPromotionCodeRestrictionsOutputWithContext(context.Context) PromotionCodeRestrictionsOutput
}

PromotionCodeRestrictionsInput is an input type that accepts PromotionCodeRestrictionsArgs and PromotionCodeRestrictionsOutput values. You can construct a concrete instance of `PromotionCodeRestrictionsInput` via:

PromotionCodeRestrictionsArgs{...}

type PromotionCodeRestrictionsOutput

type PromotionCodeRestrictionsOutput struct{ *pulumi.OutputState }

func (PromotionCodeRestrictionsOutput) ElementType

func (PromotionCodeRestrictionsOutput) FirstTimeTransaction

func (o PromotionCodeRestrictionsOutput) FirstTimeTransaction() pulumi.BoolOutput

Bool. A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices.

func (PromotionCodeRestrictionsOutput) MinimumAmount

Int. Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).

func (PromotionCodeRestrictionsOutput) MinimumAmountCurrency

func (o PromotionCodeRestrictionsOutput) MinimumAmountCurrency() pulumi.StringOutput

String. Three-letter ISO code for `minimumAmount`.

func (PromotionCodeRestrictionsOutput) ToPromotionCodeRestrictionsOutput

func (o PromotionCodeRestrictionsOutput) ToPromotionCodeRestrictionsOutput() PromotionCodeRestrictionsOutput

func (PromotionCodeRestrictionsOutput) ToPromotionCodeRestrictionsOutputWithContext

func (o PromotionCodeRestrictionsOutput) ToPromotionCodeRestrictionsOutputWithContext(ctx context.Context) PromotionCodeRestrictionsOutput

func (PromotionCodeRestrictionsOutput) ToPromotionCodeRestrictionsPtrOutput

func (o PromotionCodeRestrictionsOutput) ToPromotionCodeRestrictionsPtrOutput() PromotionCodeRestrictionsPtrOutput

func (PromotionCodeRestrictionsOutput) ToPromotionCodeRestrictionsPtrOutputWithContext

func (o PromotionCodeRestrictionsOutput) ToPromotionCodeRestrictionsPtrOutputWithContext(ctx context.Context) PromotionCodeRestrictionsPtrOutput

type PromotionCodeRestrictionsPtrInput

type PromotionCodeRestrictionsPtrInput interface {
	pulumi.Input

	ToPromotionCodeRestrictionsPtrOutput() PromotionCodeRestrictionsPtrOutput
	ToPromotionCodeRestrictionsPtrOutputWithContext(context.Context) PromotionCodeRestrictionsPtrOutput
}

PromotionCodeRestrictionsPtrInput is an input type that accepts PromotionCodeRestrictionsArgs, PromotionCodeRestrictionsPtr and PromotionCodeRestrictionsPtrOutput values. You can construct a concrete instance of `PromotionCodeRestrictionsPtrInput` via:

        PromotionCodeRestrictionsArgs{...}

or:

        nil

type PromotionCodeRestrictionsPtrOutput

type PromotionCodeRestrictionsPtrOutput struct{ *pulumi.OutputState }

func (PromotionCodeRestrictionsPtrOutput) Elem

func (PromotionCodeRestrictionsPtrOutput) ElementType

func (PromotionCodeRestrictionsPtrOutput) FirstTimeTransaction

func (o PromotionCodeRestrictionsPtrOutput) FirstTimeTransaction() pulumi.BoolPtrOutput

Bool. A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices.

func (PromotionCodeRestrictionsPtrOutput) MinimumAmount

Int. Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).

func (PromotionCodeRestrictionsPtrOutput) MinimumAmountCurrency

func (o PromotionCodeRestrictionsPtrOutput) MinimumAmountCurrency() pulumi.StringPtrOutput

String. Three-letter ISO code for `minimumAmount`.

func (PromotionCodeRestrictionsPtrOutput) ToPromotionCodeRestrictionsPtrOutput

func (o PromotionCodeRestrictionsPtrOutput) ToPromotionCodeRestrictionsPtrOutput() PromotionCodeRestrictionsPtrOutput

func (PromotionCodeRestrictionsPtrOutput) ToPromotionCodeRestrictionsPtrOutputWithContext

func (o PromotionCodeRestrictionsPtrOutput) ToPromotionCodeRestrictionsPtrOutputWithContext(ctx context.Context) PromotionCodeRestrictionsPtrOutput

type PromotionCodeState

type PromotionCodeState struct {
	// Bool. Whether the promotion code is currently active. Defaults to `true`.
	Active pulumi.BoolPtrInput
	// String. The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.
	Code pulumi.StringPtrInput
	// String. The coupon for this promotion code.
	Coupon pulumi.StringPtrInput
	// String. The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
	Customer pulumi.StringPtrInput
	// String. The timestamp at which this promotion code will expire. If the coupon has specified a `redeemsBy`, then this value cannot be after the coupon’s `redeemsBy`. Expected format is `RFC3339`.
	ExpiresAt pulumi.StringPtrInput
	// Int. A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `maxRedemptions`, then this value cannot be greater than the coupon’s `maxRedemptions`.
	MaxRedemptions pulumi.IntPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// List(Resource). Settings that restrict the redemption of the promotion code. For details of individual arguments see Restrictions.
	Restrictions PromotionCodeRestrictionsPtrInput
}

func (PromotionCodeState) ElementType

func (PromotionCodeState) ElementType() reflect.Type

type Provider

type Provider struct {
	pulumi.ProviderResourceState

	// The Stripe secret API key
	ApiKey pulumi.StringOutput `pulumi:"apiKey"`
}

The provider type for the stripe package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
	// The Stripe secret API key
	ApiKey pulumi.StringInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ApiKey

func (o ProviderOutput) ApiKey() pulumi.StringOutput

The Stripe secret API key

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type TaxRate

type TaxRate struct {
	pulumi.CustomResourceState

	// Bool. Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
	Active pulumi.BoolPtrOutput `pulumi:"active"`
	// String. Two-letter country code (ISO 3166-1 alpha-2).
	Country pulumi.StringPtrOutput `pulumi:"country"`
	// Int. Time at which the object was created. Measured in seconds since the Unix epoch.
	Created pulumi.IntOutput `pulumi:"created"`
	// String. An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// String. The display name of the tax rate, which will be shown to users.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Bool. This specifies if the tax rate is inclusive or exclusive.
	// * ` percentage  ` - (Required) Float. This represents the tax rate percent out of 100.
	Inclusive pulumi.BoolOutput `pulumi:"inclusive"`
	// String. The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
	Jurisdiction pulumi.StringPtrOutput `pulumi:"jurisdiction"`
	// Bool. Has the value true if the object exists in live mode or the value false if the object exists in test mode.
	Livemode pulumi.BoolOutput `pulumi:"livemode"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// String. String representing the object’s type. Objects of the same type share the same value.
	Object pulumi.StringOutput `pulumi:"object"`
	// This represents the tax rate percent out of 100.
	Percentage pulumi.Float64Output `pulumi:"percentage"`
	// String. ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.
	State pulumi.StringPtrOutput `pulumi:"state"`
	// String. The high-level tax type, such as vat or sales_tax.
	TaxType pulumi.StringPtrOutput `pulumi:"taxType"`
}

With this resource, you can create a tax rate - [Stripe API tax rate documentation](https://stripe.com/docs/api/tax_rates).

Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.

## Example Usage

```go package main

import (

"github.com/georgegebbett/pulumi-stripe/sdk/go/stripe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stripe.NewTaxRate(ctx, "taxRate", &stripe.TaxRateArgs{
			Active:       pulumi.Bool(true),
			Country:      pulumi.String("AU"),
			Description:  pulumi.String("GST Australia"),
			DisplayName:  pulumi.String("GST"),
			Inclusive:    pulumi.Bool(true),
			Jurisdiction: pulumi.String("AU"),
			Metadata:     nil,
			Percentage:   pulumi.Float64(10),
			State:        pulumi.String(""),
			TaxType:      pulumi.String(""),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetTaxRate

func GetTaxRate(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *TaxRateState, opts ...pulumi.ResourceOption) (*TaxRate, error)

GetTaxRate gets an existing TaxRate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewTaxRate

func NewTaxRate(ctx *pulumi.Context,
	name string, args *TaxRateArgs, opts ...pulumi.ResourceOption) (*TaxRate, error)

NewTaxRate registers a new resource with the given unique name, arguments, and options.

func (*TaxRate) ElementType

func (*TaxRate) ElementType() reflect.Type

func (*TaxRate) ToTaxRateOutput

func (i *TaxRate) ToTaxRateOutput() TaxRateOutput

func (*TaxRate) ToTaxRateOutputWithContext

func (i *TaxRate) ToTaxRateOutputWithContext(ctx context.Context) TaxRateOutput

type TaxRateArgs

type TaxRateArgs struct {
	// Bool. Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
	Active pulumi.BoolPtrInput
	// String. Two-letter country code (ISO 3166-1 alpha-2).
	Country pulumi.StringPtrInput
	// String. An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
	Description pulumi.StringPtrInput
	// String. The display name of the tax rate, which will be shown to users.
	DisplayName pulumi.StringInput
	// Bool. This specifies if the tax rate is inclusive or exclusive.
	// * ` percentage  ` - (Required) Float. This represents the tax rate percent out of 100.
	Inclusive pulumi.BoolInput
	// String. The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
	Jurisdiction pulumi.StringPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
	Metadata pulumi.StringMapInput
	// This represents the tax rate percent out of 100.
	Percentage pulumi.Float64Input
	// String. ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.
	State pulumi.StringPtrInput
	// String. The high-level tax type, such as vat or sales_tax.
	TaxType pulumi.StringPtrInput
}

The set of arguments for constructing a TaxRate resource.

func (TaxRateArgs) ElementType

func (TaxRateArgs) ElementType() reflect.Type

type TaxRateArray

type TaxRateArray []TaxRateInput

func (TaxRateArray) ElementType

func (TaxRateArray) ElementType() reflect.Type

func (TaxRateArray) ToTaxRateArrayOutput

func (i TaxRateArray) ToTaxRateArrayOutput() TaxRateArrayOutput

func (TaxRateArray) ToTaxRateArrayOutputWithContext

func (i TaxRateArray) ToTaxRateArrayOutputWithContext(ctx context.Context) TaxRateArrayOutput

type TaxRateArrayInput

type TaxRateArrayInput interface {
	pulumi.Input

	ToTaxRateArrayOutput() TaxRateArrayOutput
	ToTaxRateArrayOutputWithContext(context.Context) TaxRateArrayOutput
}

TaxRateArrayInput is an input type that accepts TaxRateArray and TaxRateArrayOutput values. You can construct a concrete instance of `TaxRateArrayInput` via:

TaxRateArray{ TaxRateArgs{...} }

type TaxRateArrayOutput

type TaxRateArrayOutput struct{ *pulumi.OutputState }

func (TaxRateArrayOutput) ElementType

func (TaxRateArrayOutput) ElementType() reflect.Type

func (TaxRateArrayOutput) Index

func (TaxRateArrayOutput) ToTaxRateArrayOutput

func (o TaxRateArrayOutput) ToTaxRateArrayOutput() TaxRateArrayOutput

func (TaxRateArrayOutput) ToTaxRateArrayOutputWithContext

func (o TaxRateArrayOutput) ToTaxRateArrayOutputWithContext(ctx context.Context) TaxRateArrayOutput

type TaxRateInput

type TaxRateInput interface {
	pulumi.Input

	ToTaxRateOutput() TaxRateOutput
	ToTaxRateOutputWithContext(ctx context.Context) TaxRateOutput
}

type TaxRateMap

type TaxRateMap map[string]TaxRateInput

func (TaxRateMap) ElementType

func (TaxRateMap) ElementType() reflect.Type

func (TaxRateMap) ToTaxRateMapOutput

func (i TaxRateMap) ToTaxRateMapOutput() TaxRateMapOutput

func (TaxRateMap) ToTaxRateMapOutputWithContext

func (i TaxRateMap) ToTaxRateMapOutputWithContext(ctx context.Context) TaxRateMapOutput

type TaxRateMapInput

type TaxRateMapInput interface {
	pulumi.Input

	ToTaxRateMapOutput() TaxRateMapOutput
	ToTaxRateMapOutputWithContext(context.Context) TaxRateMapOutput
}

TaxRateMapInput is an input type that accepts TaxRateMap and TaxRateMapOutput values. You can construct a concrete instance of `TaxRateMapInput` via:

TaxRateMap{ "key": TaxRateArgs{...} }

type TaxRateMapOutput

type TaxRateMapOutput struct{ *pulumi.OutputState }

func (TaxRateMapOutput) ElementType

func (TaxRateMapOutput) ElementType() reflect.Type

func (TaxRateMapOutput) MapIndex

func (TaxRateMapOutput) ToTaxRateMapOutput

func (o TaxRateMapOutput) ToTaxRateMapOutput() TaxRateMapOutput

func (TaxRateMapOutput) ToTaxRateMapOutputWithContext

func (o TaxRateMapOutput) ToTaxRateMapOutputWithContext(ctx context.Context) TaxRateMapOutput

type TaxRateOutput

type TaxRateOutput struct{ *pulumi.OutputState }

func (TaxRateOutput) Active

func (o TaxRateOutput) Active() pulumi.BoolPtrOutput

Bool. Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

func (TaxRateOutput) Country

func (o TaxRateOutput) Country() pulumi.StringPtrOutput

String. Two-letter country code (ISO 3166-1 alpha-2).

func (TaxRateOutput) Created

func (o TaxRateOutput) Created() pulumi.IntOutput

Int. Time at which the object was created. Measured in seconds since the Unix epoch.

func (TaxRateOutput) Description

func (o TaxRateOutput) Description() pulumi.StringPtrOutput

String. An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

func (TaxRateOutput) DisplayName

func (o TaxRateOutput) DisplayName() pulumi.StringOutput

String. The display name of the tax rate, which will be shown to users.

func (TaxRateOutput) ElementType

func (TaxRateOutput) ElementType() reflect.Type

func (TaxRateOutput) Inclusive

func (o TaxRateOutput) Inclusive() pulumi.BoolOutput

Bool. This specifies if the tax rate is inclusive or exclusive. * ` percentage ` - (Required) Float. This represents the tax rate percent out of 100.

func (TaxRateOutput) Jurisdiction

func (o TaxRateOutput) Jurisdiction() pulumi.StringPtrOutput

String. The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

func (TaxRateOutput) Livemode

func (o TaxRateOutput) Livemode() pulumi.BoolOutput

Bool. Has the value true if the object exists in live mode or the value false if the object exists in test mode.

func (TaxRateOutput) Metadata

func (o TaxRateOutput) Metadata() pulumi.StringMapOutput

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

func (TaxRateOutput) Object

func (o TaxRateOutput) Object() pulumi.StringOutput

String. String representing the object’s type. Objects of the same type share the same value.

func (TaxRateOutput) Percentage

func (o TaxRateOutput) Percentage() pulumi.Float64Output

This represents the tax rate percent out of 100.

func (TaxRateOutput) State

String. ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

func (TaxRateOutput) TaxType

func (o TaxRateOutput) TaxType() pulumi.StringPtrOutput

String. The high-level tax type, such as vat or sales_tax.

func (TaxRateOutput) ToTaxRateOutput

func (o TaxRateOutput) ToTaxRateOutput() TaxRateOutput

func (TaxRateOutput) ToTaxRateOutputWithContext

func (o TaxRateOutput) ToTaxRateOutputWithContext(ctx context.Context) TaxRateOutput

type TaxRateState

type TaxRateState struct {
	// Bool. Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
	Active pulumi.BoolPtrInput
	// String. Two-letter country code (ISO 3166-1 alpha-2).
	Country pulumi.StringPtrInput
	// Int. Time at which the object was created. Measured in seconds since the Unix epoch.
	Created pulumi.IntPtrInput
	// String. An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
	Description pulumi.StringPtrInput
	// String. The display name of the tax rate, which will be shown to users.
	DisplayName pulumi.StringPtrInput
	// Bool. This specifies if the tax rate is inclusive or exclusive.
	// * ` percentage  ` - (Required) Float. This represents the tax rate percent out of 100.
	Inclusive pulumi.BoolPtrInput
	// String. The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
	Jurisdiction pulumi.StringPtrInput
	// Bool. Has the value true if the object exists in live mode or the value false if the object exists in test mode.
	Livemode pulumi.BoolPtrInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
	Metadata pulumi.StringMapInput
	// String. String representing the object’s type. Objects of the same type share the same value.
	Object pulumi.StringPtrInput
	// This represents the tax rate percent out of 100.
	Percentage pulumi.Float64PtrInput
	// String. ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.
	State pulumi.StringPtrInput
	// String. The high-level tax type, such as vat or sales_tax.
	TaxType pulumi.StringPtrInput
}

func (TaxRateState) ElementType

func (TaxRateState) ElementType() reflect.Type

type WebhookEndpoint

type WebhookEndpoint struct {
	pulumi.CustomResourceState

	// String. Events sent to this endpoint will be generated with this Stripe Version instead of your account’s default Stripe Version.
	ApiVersion pulumi.StringPtrOutput `pulumi:"apiVersion"`
	// Bool. Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.
	Connect pulumi.BoolPtrOutput `pulumi:"connect"`
	// String. Description of what the webhook is used for.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Bool. Disable the webhook endpoint if set to `true`. Can be used only for modification already existing webhook endpoint.
	Disabled pulumi.BoolPtrOutput `pulumi:"disabled"`
	// List(String). The list of events to enable for this endpoint. `[*]` indicates that all events are enabled, except those that require explicit selection. All supported events listed here: [Stripe event types](https://stripe.com/docs/api/events/types).
	EnabledEvents pulumi.StringArrayOutput `pulumi:"enabledEvents"`
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapOutput `pulumi:"metadata"`
	// String. The endpoint’s secret, used to generate webhook signatures. This field is marked as `sensitive`.
	Secret pulumi.StringOutput `pulumi:"secret"`
	// String. The URL of the webhook endpoint.
	Url pulumi.StringOutput `pulumi:"url"`
}

With this resource, you can create a webhook endpoint - [Stripe API webhook endpoint documentation](https://stripe.com/docs/api/webhook_endpoints).

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

## Example Usage

```go package main

import (

"github.com/georgegebbett/pulumi-stripe/sdk/go/stripe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := stripe.NewWebhookEndpoint(ctx, "webhook", &stripe.WebhookEndpointArgs{
			Description: pulumi.String("example of webhook"),
			EnabledEvents: pulumi.StringArray{
				pulumi.String("customer.subscription.created"),
				pulumi.String("customer.subscription.updated"),
			},
			Url: pulumi.String("https://webhook-url-consumer.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetWebhookEndpoint

func GetWebhookEndpoint(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WebhookEndpointState, opts ...pulumi.ResourceOption) (*WebhookEndpoint, error)

GetWebhookEndpoint gets an existing WebhookEndpoint resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWebhookEndpoint

func NewWebhookEndpoint(ctx *pulumi.Context,
	name string, args *WebhookEndpointArgs, opts ...pulumi.ResourceOption) (*WebhookEndpoint, error)

NewWebhookEndpoint registers a new resource with the given unique name, arguments, and options.

func (*WebhookEndpoint) ElementType

func (*WebhookEndpoint) ElementType() reflect.Type

func (*WebhookEndpoint) ToWebhookEndpointOutput

func (i *WebhookEndpoint) ToWebhookEndpointOutput() WebhookEndpointOutput

func (*WebhookEndpoint) ToWebhookEndpointOutputWithContext

func (i *WebhookEndpoint) ToWebhookEndpointOutputWithContext(ctx context.Context) WebhookEndpointOutput

type WebhookEndpointArgs

type WebhookEndpointArgs struct {
	// String. Events sent to this endpoint will be generated with this Stripe Version instead of your account’s default Stripe Version.
	ApiVersion pulumi.StringPtrInput
	// Bool. Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.
	Connect pulumi.BoolPtrInput
	// String. Description of what the webhook is used for.
	Description pulumi.StringPtrInput
	// Bool. Disable the webhook endpoint if set to `true`. Can be used only for modification already existing webhook endpoint.
	Disabled pulumi.BoolPtrInput
	// List(String). The list of events to enable for this endpoint. `[*]` indicates that all events are enabled, except those that require explicit selection. All supported events listed here: [Stripe event types](https://stripe.com/docs/api/events/types).
	EnabledEvents pulumi.StringArrayInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. The URL of the webhook endpoint.
	Url pulumi.StringInput
}

The set of arguments for constructing a WebhookEndpoint resource.

func (WebhookEndpointArgs) ElementType

func (WebhookEndpointArgs) ElementType() reflect.Type

type WebhookEndpointArray

type WebhookEndpointArray []WebhookEndpointInput

func (WebhookEndpointArray) ElementType

func (WebhookEndpointArray) ElementType() reflect.Type

func (WebhookEndpointArray) ToWebhookEndpointArrayOutput

func (i WebhookEndpointArray) ToWebhookEndpointArrayOutput() WebhookEndpointArrayOutput

func (WebhookEndpointArray) ToWebhookEndpointArrayOutputWithContext

func (i WebhookEndpointArray) ToWebhookEndpointArrayOutputWithContext(ctx context.Context) WebhookEndpointArrayOutput

type WebhookEndpointArrayInput

type WebhookEndpointArrayInput interface {
	pulumi.Input

	ToWebhookEndpointArrayOutput() WebhookEndpointArrayOutput
	ToWebhookEndpointArrayOutputWithContext(context.Context) WebhookEndpointArrayOutput
}

WebhookEndpointArrayInput is an input type that accepts WebhookEndpointArray and WebhookEndpointArrayOutput values. You can construct a concrete instance of `WebhookEndpointArrayInput` via:

WebhookEndpointArray{ WebhookEndpointArgs{...} }

type WebhookEndpointArrayOutput

type WebhookEndpointArrayOutput struct{ *pulumi.OutputState }

func (WebhookEndpointArrayOutput) ElementType

func (WebhookEndpointArrayOutput) ElementType() reflect.Type

func (WebhookEndpointArrayOutput) Index

func (WebhookEndpointArrayOutput) ToWebhookEndpointArrayOutput

func (o WebhookEndpointArrayOutput) ToWebhookEndpointArrayOutput() WebhookEndpointArrayOutput

func (WebhookEndpointArrayOutput) ToWebhookEndpointArrayOutputWithContext

func (o WebhookEndpointArrayOutput) ToWebhookEndpointArrayOutputWithContext(ctx context.Context) WebhookEndpointArrayOutput

type WebhookEndpointInput

type WebhookEndpointInput interface {
	pulumi.Input

	ToWebhookEndpointOutput() WebhookEndpointOutput
	ToWebhookEndpointOutputWithContext(ctx context.Context) WebhookEndpointOutput
}

type WebhookEndpointMap

type WebhookEndpointMap map[string]WebhookEndpointInput

func (WebhookEndpointMap) ElementType

func (WebhookEndpointMap) ElementType() reflect.Type

func (WebhookEndpointMap) ToWebhookEndpointMapOutput

func (i WebhookEndpointMap) ToWebhookEndpointMapOutput() WebhookEndpointMapOutput

func (WebhookEndpointMap) ToWebhookEndpointMapOutputWithContext

func (i WebhookEndpointMap) ToWebhookEndpointMapOutputWithContext(ctx context.Context) WebhookEndpointMapOutput

type WebhookEndpointMapInput

type WebhookEndpointMapInput interface {
	pulumi.Input

	ToWebhookEndpointMapOutput() WebhookEndpointMapOutput
	ToWebhookEndpointMapOutputWithContext(context.Context) WebhookEndpointMapOutput
}

WebhookEndpointMapInput is an input type that accepts WebhookEndpointMap and WebhookEndpointMapOutput values. You can construct a concrete instance of `WebhookEndpointMapInput` via:

WebhookEndpointMap{ "key": WebhookEndpointArgs{...} }

type WebhookEndpointMapOutput

type WebhookEndpointMapOutput struct{ *pulumi.OutputState }

func (WebhookEndpointMapOutput) ElementType

func (WebhookEndpointMapOutput) ElementType() reflect.Type

func (WebhookEndpointMapOutput) MapIndex

func (WebhookEndpointMapOutput) ToWebhookEndpointMapOutput

func (o WebhookEndpointMapOutput) ToWebhookEndpointMapOutput() WebhookEndpointMapOutput

func (WebhookEndpointMapOutput) ToWebhookEndpointMapOutputWithContext

func (o WebhookEndpointMapOutput) ToWebhookEndpointMapOutputWithContext(ctx context.Context) WebhookEndpointMapOutput

type WebhookEndpointOutput

type WebhookEndpointOutput struct{ *pulumi.OutputState }

func (WebhookEndpointOutput) ApiVersion

String. Events sent to this endpoint will be generated with this Stripe Version instead of your account’s default Stripe Version.

func (WebhookEndpointOutput) Connect

Bool. Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.

func (WebhookEndpointOutput) Description

String. Description of what the webhook is used for.

func (WebhookEndpointOutput) Disabled

Bool. Disable the webhook endpoint if set to `true`. Can be used only for modification already existing webhook endpoint.

func (WebhookEndpointOutput) ElementType

func (WebhookEndpointOutput) ElementType() reflect.Type

func (WebhookEndpointOutput) EnabledEvents

List(String). The list of events to enable for this endpoint. `[*]` indicates that all events are enabled, except those that require explicit selection. All supported events listed here: [Stripe event types](https://stripe.com/docs/api/events/types).

func (WebhookEndpointOutput) Metadata

Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

func (WebhookEndpointOutput) Secret

String. The endpoint’s secret, used to generate webhook signatures. This field is marked as `sensitive`.

func (WebhookEndpointOutput) ToWebhookEndpointOutput

func (o WebhookEndpointOutput) ToWebhookEndpointOutput() WebhookEndpointOutput

func (WebhookEndpointOutput) ToWebhookEndpointOutputWithContext

func (o WebhookEndpointOutput) ToWebhookEndpointOutputWithContext(ctx context.Context) WebhookEndpointOutput

func (WebhookEndpointOutput) Url

String. The URL of the webhook endpoint.

type WebhookEndpointState

type WebhookEndpointState struct {
	// String. Events sent to this endpoint will be generated with this Stripe Version instead of your account’s default Stripe Version.
	ApiVersion pulumi.StringPtrInput
	// Bool. Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.
	Connect pulumi.BoolPtrInput
	// String. Description of what the webhook is used for.
	Description pulumi.StringPtrInput
	// Bool. Disable the webhook endpoint if set to `true`. Can be used only for modification already existing webhook endpoint.
	Disabled pulumi.BoolPtrInput
	// List(String). The list of events to enable for this endpoint. `[*]` indicates that all events are enabled, except those that require explicit selection. All supported events listed here: [Stripe event types](https://stripe.com/docs/api/events/types).
	EnabledEvents pulumi.StringArrayInput
	// Map(String). Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
	Metadata pulumi.StringMapInput
	// String. The endpoint’s secret, used to generate webhook signatures. This field is marked as `sensitive`.
	Secret pulumi.StringPtrInput
	// String. The URL of the webhook endpoint.
	Url pulumi.StringPtrInput
}

func (WebhookEndpointState) ElementType

func (WebhookEndpointState) ElementType() reflect.Type

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL