Stripe.Params.SubscriptionItemUpdateParams (tiger_stripe v0.4.0)

Copy Markdown View Source

Parameters for subscription item update.

Summary

Types

t()

Types

t()

@type t() :: %Stripe.Params.SubscriptionItemUpdateParams{
  billing_thresholds: term(),
  discounts: term(),
  expand: term(),
  metadata: term(),
  off_session: term(),
  payment_behavior: term(),
  plan: term(),
  price: term(),
  price_data: term(),
  proration_behavior: term(),
  proration_date: term(),
  quantity: term(),
  tax_rates: term()
}
  • 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.
  • off_session - Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).
  • payment_behavior - Controls how Stripe handles payment when a subscription update requires payment and collection_method=charge_automatically. Possible values: allow_incomplete, default_incomplete, error_if_incomplete, pending_if_incomplete.
  • plan - The identifier of the new plan for this subscription item. Max length: 5000.
  • price - The ID of the price object. One of price or price_data is required. When changing a subscription item's price, quantity is set to 1 unless a quantity parameter is provided. Max length: 5000.
  • price_data - Data used to generate a new Price object inline. One of price or price_data is required.
  • 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.
  • 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.