Search documentation of stripe_elixir

# StripeElixir.Params.QuoteCreateParams.SubscriptionData (stripe_elixir v0.1.0)

Copy Markdown View Source

Nested parameters.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.QuoteCreateParams.SubscriptionData{
      billing_mode: map() | nil,
      description: String.t() | nil,
      effective_date: map() | nil,
      metadata: map() | nil,
      trial_period_days: map() | nil
    }

- `billing_mode` - Controls how prorations and invoices for subscriptions are calculated and orchestrated.
- `description` - The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. Max length: 500.
- `effective_date` - When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. The `effective_date` is ignored if it is in the past when the quote is accepted.
- `metadata` - Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
- `trial_period_days` - Integer representing the number of trial period days before the customer is charged for the first time.