Search documentation of stripe_elixir

# StripeElixir.Params.SubscriptionItemCreateParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for subscription item create.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.SubscriptionItemCreateParams{
      billing_thresholds: map() | nil,
      discounts: map() | nil,
      expand: [String.t()] | nil,
      metadata: map() | nil,
      payment_behavior: String.t() | nil,
      plan: String.t() | nil,
      price: String.t() | nil,
      price_data: map() | nil,
      proration_behavior: String.t() | nil,
      proration_date: integer() | nil,
      quantity: integer() | nil,
      subscription: String.t(),
      tax_rates: map() | nil
    }

- `billing_thresholds` - Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
- `discounts` - The coupons to redeem into discounts for the subscription item.
- `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`.
- `payment_behavior` - Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.

Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.

Use `pending_if_incomplete` to update the subscription using pending updates. When you use `pending_if_incomplete` you can only pass the parameters supported by pending updates.

Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more. Possible values: `allow_incomplete`, `default_incomplete`, `error_if_incomplete`, `pending_if_incomplete`.

- `plan` - The identifier of the plan to add to the subscription. Max length: 5000.
- `price` - The ID of the price object. Max length: 5000.
- `price_data` - Data used to generate a new Price object inline.
- `proration_behavior` - Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. Possible values: `always_invoice`, `create_prorations`, `none`.
- `proration_date` - If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the upcoming invoice endpoint. Format: Unix timestamp.
- `quantity` - The quantity you'd like to apply to the subscription item you're creating.
- `subscription` - The identifier of the subscription to modify. Max length: 5000.
- `tax_rates` - A list of Tax Rate ids. These Tax Rates will override the `default_tax_rates` on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.