Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. ProductCatalogTrialOffer
Viewing docs for Stripe 0.3.1
published on Friday, Nov 13, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.ProductCatalogTrialOffer

Stripe
Viewing docs for Stripe 0.3.1
published on Friday, Nov 13, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    Create ProductCatalogTrialOffer Resource

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

    Constructor syntax

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

@overload
def ProductCatalogTrialOffer(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             duration: Optional[ProductCatalogTrialOfferDurationArgs] = None,
                             end_behavior: Optional[ProductCatalogTrialOfferEndBehaviorArgs] = None,
                             price: Optional[str] = None,
                             active: Optional[bool] = None,
                             nickname: Optional[str] = None)
    func NewProductCatalogTrialOffer(ctx *Context, name string, args ProductCatalogTrialOfferArgs, opts ...ResourceOption) (*ProductCatalogTrialOffer, error)
    public ProductCatalogTrialOffer(string name, ProductCatalogTrialOfferArgs args, CustomResourceOptions? opts = null)
    public ProductCatalogTrialOffer(String name, ProductCatalogTrialOfferArgs args)
public ProductCatalogTrialOffer(String name, ProductCatalogTrialOfferArgs args, CustomResourceOptions options)

    type: stripe:ProductCatalogTrialOffer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_product_catalog_trial_offer" "name" {
    # resource properties
}

    Parameters

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

    Constructor example

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

    var productCatalogTrialOfferResource = new Stripe.ProductCatalogTrialOffer("productCatalogTrialOfferResource", new()
{
    Duration = new Stripe.Inputs.ProductCatalogTrialOfferDurationArgs
    {
        Type = "string",
        Relative = new Stripe.Inputs.ProductCatalogTrialOfferDurationRelativeArgs
        {
            Iterations = 0.0,
        },
    },
    EndBehavior = new Stripe.Inputs.ProductCatalogTrialOfferEndBehaviorArgs
    {
        Transition = new Stripe.Inputs.ProductCatalogTrialOfferEndBehaviorTransitionArgs
        {
            Price = "string",
        },
        Type = "string",
    },
    Price = "string",
    Active = false,
    Nickname = "string",
});

    example, err := stripe.NewProductCatalogTrialOffer(ctx, "productCatalogTrialOfferResource", &stripe.ProductCatalogTrialOfferArgs{
	Duration: &stripe.ProductCatalogTrialOfferDurationArgs{
		Type: pulumi.String("string"),
		Relative: &stripe.ProductCatalogTrialOfferDurationRelativeArgs{
			Iterations: pulumi.Float64(0),
		},
	},
	EndBehavior: &stripe.ProductCatalogTrialOfferEndBehaviorArgs{
		Transition: &stripe.ProductCatalogTrialOfferEndBehaviorTransitionArgs{
			Price: pulumi.String("string"),
		},
		Type: pulumi.String("string"),
	},
	Price:    pulumi.String("string"),
	Active:   pulumi.Bool(false),
	Nickname: pulumi.String("string"),
})

    resource "stripe_product_catalog_trial_offer" "productCatalogTrialOfferResource" {
  lifecycle {
    create_before_destroy = true
  }
  duration = {
    type = "string"
    relative = {
      iterations = 0
    }
  }
  end_behavior = {
    transition = {
      price = "string"
    }
    type = "string"
  }
  price    = "string"
  active   = false
  nickname = "string"
}

    var productCatalogTrialOfferResource = new ProductCatalogTrialOffer("productCatalogTrialOfferResource", ProductCatalogTrialOfferArgs.builder()
    .duration(ProductCatalogTrialOfferDurationArgs.builder()
        .type("string")
        .relative(ProductCatalogTrialOfferDurationRelativeArgs.builder()
            .iterations(0.0)
            .build())
        .build())
    .endBehavior(ProductCatalogTrialOfferEndBehaviorArgs.builder()
        .transition(ProductCatalogTrialOfferEndBehaviorTransitionArgs.builder()
            .price("string")
            .build())
        .type("string")
        .build())
    .price("string")
    .active(false)
    .nickname("string")
    .build());

    product_catalog_trial_offer_resource = stripe.ProductCatalogTrialOffer("productCatalogTrialOfferResource",
    duration={
        "type": "string",
        "relative": {
            "iterations": float(0),
        },
    },
    end_behavior={
        "transition": {
            "price": "string",
        },
        "type": "string",
    },
    price="string",
    active=False,
    nickname="string")

    const productCatalogTrialOfferResource = new stripe.ProductCatalogTrialOffer("productCatalogTrialOfferResource", {
    duration: {
        type: "string",
        relative: {
            iterations: 0,
        },
    },
    endBehavior: {
        transition: {
            price: "string",
        },
        type: "string",
    },
    price: "string",
    active: false,
    nickname: "string",
});

    type: stripe:ProductCatalogTrialOffer
properties:
    active: false
    duration:
        relative:
            iterations: 0
        type: string
    endBehavior:
        transition:
            price: string
        type: string
    nickname: string
    price: string

    ProductCatalogTrialOffer Resource Properties

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

    Inputs

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

    The ProductCatalogTrialOffer resource accepts the following input properties:

    Duration ProductCatalogTrialOfferDuration
    EndBehavior ProductCatalogTrialOfferEndBehavior
    Price string
    The price during the trial offer.
    Active bool
    Whether the trial offer is active. Set to false to archive the trial offer.
    Nickname string
    A brief description of the trial offer, hidden from customers.
    Duration ProductCatalogTrialOfferDurationArgs
    EndBehavior ProductCatalogTrialOfferEndBehaviorArgs
    Price string
    The price during the trial offer.
    Active bool
    Whether the trial offer is active. Set to false to archive the trial offer.
    Nickname string
    A brief description of the trial offer, hidden from customers.
    duration object
    end_behavior object
    price string
    The price during the trial offer.
    active bool
    Whether the trial offer is active. Set to false to archive the trial offer.
    nickname string
    A brief description of the trial offer, hidden from customers.
    duration ProductCatalogTrialOfferDuration
    endBehavior ProductCatalogTrialOfferEndBehavior
    price String
    The price during the trial offer.
    active Boolean
    Whether the trial offer is active. Set to false to archive the trial offer.
    nickname String
    A brief description of the trial offer, hidden from customers.
    duration ProductCatalogTrialOfferDuration
    endBehavior ProductCatalogTrialOfferEndBehavior
    price string
    The price during the trial offer.
    active boolean
    Whether the trial offer is active. Set to false to archive the trial offer.
    nickname string
    A brief description of the trial offer, hidden from customers.
    duration ProductCatalogTrialOfferDurationArgs
    end_behavior ProductCatalogTrialOfferEndBehaviorArgs
    price str
    The price during the trial offer.
    active bool
    Whether the trial offer is active. Set to false to archive the trial offer.
    nickname str
    A brief description of the trial offer, hidden from customers.
    duration Property Map
    endBehavior Property Map
    price String
    The price during the trial offer.
    active Boolean
    Whether the trial offer is active. Set to false to archive the trial offer.
    nickname String
    A brief description of the trial offer, hidden from customers.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Id string
    The provider-assigned unique ID for this managed resource.
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.
    id string
    The provider-assigned unique ID for this managed resource.
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object string
    String representing the object's type. Objects of the same type share the same value.
    id str
    The provider-assigned unique ID for this managed resource.
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object str
    String representing the object's type. Objects of the same type share the same value.
    id String
    The provider-assigned unique ID for this managed resource.
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    object String
    String representing the object's type. Objects of the same type share the same value.

    Look up Existing ProductCatalogTrialOffer Resource

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

    public static get(name: string, id: Input<ID>, state?: ProductCatalogTrialOfferState, opts?: CustomResourceOptions): ProductCatalogTrialOffer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        duration: Optional[ProductCatalogTrialOfferDurationArgs] = None,
        end_behavior: Optional[ProductCatalogTrialOfferEndBehaviorArgs] = None,
        livemode: Optional[bool] = None,
        nickname: Optional[str] = None,
        object: Optional[str] = None,
        price: Optional[str] = None) -> ProductCatalogTrialOffer
    func GetProductCatalogTrialOffer(ctx *Context, name string, id IDInput, state *ProductCatalogTrialOfferState, opts ...ResourceOption) (*ProductCatalogTrialOffer, error)
    public static ProductCatalogTrialOffer Get(string name, Input<string> id, ProductCatalogTrialOfferState? state, CustomResourceOptions? opts = null)
    public static ProductCatalogTrialOffer get(String name, Output<String> id, ProductCatalogTrialOfferState state, CustomResourceOptions options)
    resources:  _:    type: stripe:ProductCatalogTrialOffer    get:      id: ${id}
    import {
  to = stripe_product_catalog_trial_offer.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Active bool
    Whether the trial offer is active. Set to false to archive the trial offer.
    Duration ProductCatalogTrialOfferDuration
    EndBehavior ProductCatalogTrialOfferEndBehavior
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Nickname string
    A brief description of the trial offer, hidden from customers.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Price string
    The price during the trial offer.
    Active bool
    Whether the trial offer is active. Set to false to archive the trial offer.
    Duration ProductCatalogTrialOfferDurationArgs
    EndBehavior ProductCatalogTrialOfferEndBehaviorArgs
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Nickname string
    A brief description of the trial offer, hidden from customers.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Price string
    The price during the trial offer.
    active bool
    Whether the trial offer is active. Set to false to archive the trial offer.
    duration object
    end_behavior object
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    nickname string
    A brief description of the trial offer, hidden from customers.
    object string
    String representing the object's type. Objects of the same type share the same value.
    price string
    The price during the trial offer.
    active Boolean
    Whether the trial offer is active. Set to false to archive the trial offer.
    duration ProductCatalogTrialOfferDuration
    endBehavior ProductCatalogTrialOfferEndBehavior
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    nickname String
    A brief description of the trial offer, hidden from customers.
    object String
    String representing the object's type. Objects of the same type share the same value.
    price String
    The price during the trial offer.
    active boolean
    Whether the trial offer is active. Set to false to archive the trial offer.
    duration ProductCatalogTrialOfferDuration
    endBehavior ProductCatalogTrialOfferEndBehavior
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    nickname string
    A brief description of the trial offer, hidden from customers.
    object string
    String representing the object's type. Objects of the same type share the same value.
    price string
    The price during the trial offer.
    active bool
    Whether the trial offer is active. Set to false to archive the trial offer.
    duration ProductCatalogTrialOfferDurationArgs
    end_behavior ProductCatalogTrialOfferEndBehaviorArgs
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    nickname str
    A brief description of the trial offer, hidden from customers.
    object str
    String representing the object's type. Objects of the same type share the same value.
    price str
    The price during the trial offer.
    active Boolean
    Whether the trial offer is active. Set to false to archive the trial offer.
    duration Property Map
    endBehavior Property Map
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    nickname String
    A brief description of the trial offer, hidden from customers.
    object String
    String representing the object's type. Objects of the same type share the same value.
    price String
    The price during the trial offer.

    Supporting Types

    ProductCatalogTrialOfferDuration, ProductCatalogTrialOfferDurationArgs

    Type string
    The type of trial offer duration.
    Relative ProductCatalogTrialOfferDurationRelative
    Type string
    The type of trial offer duration.
    Relative ProductCatalogTrialOfferDurationRelative
    type string
    The type of trial offer duration.
    relative object
    type String
    The type of trial offer duration.
    relative ProductCatalogTrialOfferDurationRelative
    type string
    The type of trial offer duration.
    relative ProductCatalogTrialOfferDurationRelative
    type str
    The type of trial offer duration.
    relative ProductCatalogTrialOfferDurationRelative
    type String
    The type of trial offer duration.
    relative Property Map

    ProductCatalogTrialOfferDurationRelative, ProductCatalogTrialOfferDurationRelativeArgs

    Iterations double
    The number of iterations of the price's interval for this trial offer.
    Iterations float64
    The number of iterations of the price's interval for this trial offer.
    iterations number
    The number of iterations of the price's interval for this trial offer.
    iterations Double
    The number of iterations of the price's interval for this trial offer.
    iterations number
    The number of iterations of the price's interval for this trial offer.
    iterations float
    The number of iterations of the price's interval for this trial offer.
    iterations Number
    The number of iterations of the price's interval for this trial offer.

    ProductCatalogTrialOfferEndBehavior, ProductCatalogTrialOfferEndBehaviorArgs

    Transition ProductCatalogTrialOfferEndBehaviorTransition
    Type string
    The type of behavior when the trial offer ends.
    Transition ProductCatalogTrialOfferEndBehaviorTransition
    Type string
    The type of behavior when the trial offer ends.
    transition object
    type string
    The type of behavior when the trial offer ends.
    transition ProductCatalogTrialOfferEndBehaviorTransition
    type String
    The type of behavior when the trial offer ends.
    transition ProductCatalogTrialOfferEndBehaviorTransition
    type string
    The type of behavior when the trial offer ends.
    transition ProductCatalogTrialOfferEndBehaviorTransition
    type str
    The type of behavior when the trial offer ends.
    transition Property Map
    type String
    The type of behavior when the trial offer ends.

    ProductCatalogTrialOfferEndBehaviorTransition, ProductCatalogTrialOfferEndBehaviorTransitionArgs

    Price string
    The new price to use at the end of the trial offer period.
    Price string
    The new price to use at the end of the trial offer period.
    price string
    The new price to use at the end of the trial offer period.
    price String
    The new price to use at the end of the trial offer period.
    price string
    The new price to use at the end of the trial offer period.
    price str
    The new price to use at the end of the trial offer period.
    price String
    The new price to use at the end of the trial offer period.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Stripe
    Viewing docs for Stripe 0.3.1
    published on Friday, Nov 13, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial