Search documentation of tiger_stripe

# Stripe.Params.PlanUpdateParams (tiger_stripe v0.1.1)

Copy Markdown View Source

Parameters for plan update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %Stripe.Params.PlanUpdateParams{
      active: boolean() | nil,
      expand: [String.t()] | nil,
      metadata: map() | nil,
      nickname: String.t() | nil,
      product: String.t() | nil,
      trial_period_days: integer() | nil
    }

- `active` - Whether the plan is currently available for new subscriptions.
- `expand` - Specifies which fields in the response should be expanded.
- `metadata` - 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`.
- `nickname` - A brief description of the plan, hidden from customers. Max length: 5000.
- `product` - The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. Max length: 5000.
- `trial_period_days` - Default number of trial days when subscribing a customer to this plan using `trial_from_plan=true`.