StripeAPI.Types.SubscriptionItem

Contains the types generated from the schema SubscriptionItem

Documentation

data SubscriptionItem

Defines the object schema located at components.schemas.subscription_item in the specification.

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

Constructors

SubscriptionItem

Fields

• subscriptionItemBillingThresholds :: Maybe SubscriptionItemBillingThresholds'

  billing_thresholds: Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period

• subscriptionItemCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• subscriptionItemId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• subscriptionItemMetadata :: Object

  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.

• subscriptionItemPrice :: Price

  price: Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

  For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.

  Related guides: Set up a subscription, create an invoice, and more about products and prices.

• subscriptionItemQuantity :: Maybe Int

  quantity: The quantity of the plan to which the customer should be subscribed.

• subscriptionItemSubscription :: Text

  subscription: The `subscription` this `subscription_item` belongs to.

  Constraints:

  • Maximum length of 5000
• subscriptionItemTaxRates :: Maybe [TaxRate]

  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`.

Instances

Eq SubscriptionItem

Defined in StripeAPI.Types.SubscriptionItem

Methods

(==) :: SubscriptionItem -> SubscriptionItem -> Bool

(/=) :: SubscriptionItem -> SubscriptionItem -> Bool

Show SubscriptionItem

Defined in StripeAPI.Types.SubscriptionItem

Methods

showsPrec :: Int -> SubscriptionItem -> ShowS

show :: SubscriptionItem -> String

showList :: [SubscriptionItem] -> ShowS

ToJSON SubscriptionItem

Defined in StripeAPI.Types.SubscriptionItem

Methods

toJSON :: SubscriptionItem -> Value

toEncoding :: SubscriptionItem -> Encoding

toJSONList :: [SubscriptionItem] -> Value

toEncodingList :: [SubscriptionItem] -> Encoding

FromJSON SubscriptionItem

Defined in StripeAPI.Types.SubscriptionItem

Methods

parseJSON :: Value -> Parser SubscriptionItem

parseJSONList :: Value -> Parser [SubscriptionItem]

mkSubscriptionItem

Arguments

:: Int

subscriptionItemCreated

-> Text

subscriptionItemId

-> Object

subscriptionItemMetadata

-> Price

subscriptionItemPrice

-> Text

subscriptionItemSubscription

-> SubscriptionItem

Create a new SubscriptionItem with all required fields.

data SubscriptionItemBillingThresholds'

Defines the object schema located at components.schemas.subscription_item.properties.billing_thresholds.anyOf in the specification.

Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period

Constructors

SubscriptionItemBillingThresholds'

Fields

• subscriptionItemBillingThresholds'UsageGte :: Maybe Int

  usage_gte: Usage threshold that triggers the subscription to create an invoice

Instances

Eq SubscriptionItemBillingThresholds'

Defined in StripeAPI.Types.SubscriptionItem

Methods

(==) :: SubscriptionItemBillingThresholds' -> SubscriptionItemBillingThresholds' -> Bool

(/=) :: SubscriptionItemBillingThresholds' -> SubscriptionItemBillingThresholds' -> Bool

Show SubscriptionItemBillingThresholds'

Defined in StripeAPI.Types.SubscriptionItem

Methods

showsPrec :: Int -> SubscriptionItemBillingThresholds' -> ShowS

show :: SubscriptionItemBillingThresholds' -> String

showList :: [SubscriptionItemBillingThresholds'] -> ShowS

ToJSON SubscriptionItemBillingThresholds'

Defined in StripeAPI.Types.SubscriptionItem

Methods

toJSON :: SubscriptionItemBillingThresholds' -> Value

toEncoding :: SubscriptionItemBillingThresholds' -> Encoding

toJSONList :: [SubscriptionItemBillingThresholds'] -> Value

toEncodingList :: [SubscriptionItemBillingThresholds'] -> Encoding

FromJSON SubscriptionItemBillingThresholds'

Defined in StripeAPI.Types.SubscriptionItem

Methods

parseJSON :: Value -> Parser SubscriptionItemBillingThresholds'

parseJSONList :: Value -> Parser [SubscriptionItemBillingThresholds']

mkSubscriptionItemBillingThresholds' :: SubscriptionItemBillingThresholds'

Create a new SubscriptionItemBillingThresholds' with all required fields.