Search documentation of stripe_elixir

# StripeElixir.Resources.SubscriptionItem (stripe_elixir v0.1.0)

Copy Markdown View Source

SubscriptionItem

Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.

## Summary

### Types

t()

### Functions

expandable_fields()
object_name()

## Types

# t()

    @type t() :: %StripeElixir.Resources.SubscriptionItem{
      billing_thresholds: map(),
      created: integer(),
      current_period_end: integer(),
      current_period_start: integer(),
      discounts: [String.t() | map()],
      id: String.t(),
      metadata: map(),
      object: String.t(),
      plan: String.t() | map(),
      price: String.t() | map(),
      quantity: integer() | nil,
      subscription: String.t(),
      tax_rates: [String.t() | map()]
    }

- `billing_thresholds` - Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period Nullable. Expandable.
- `created` - Time at which the object was created. Measured in seconds since the Unix epoch.
- `current_period_end` - The end time of this subscription item's current billing period. Format: Unix timestamp.
- `current_period_start` - The start time of this subscription item's current billing period. Format: Unix timestamp.
- `discounts` - The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. Expandable.
- `id` - Unique identifier for the object. Max length: 5000.
- `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.
- `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `subscription_item`.
- `plan` - Expandable.
- `price` - Expandable.
- `quantity` - The quantity of the plan to which the customer should be subscribed.
- `subscription` - The `subscription` this `subscription_item` belongs to. Max length: 5000.
- `tax_rates` - The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. Nullable. Expandable.

## Functions

# expandable_fields()

# object_name()