Package com.stripe.model

Class SubscriptionItem

    • Constructor Detail

      • SubscriptionItem

        public SubscriptionItem()

    • Method Detail

      • create

        public static SubscriptionItem create​(java.util.Map<java.lang.String,​java.lang.Object> params)
                               throws StripeException
        Adds a new item to an existing subscription. No existing items will be changed or replaced.
        Throws:
        StripeException

      • delete

        public SubscriptionItem delete​(java.util.Map<java.lang.String,​java.lang.Object> params)
                        throws StripeException
        Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.
        Throws:
        StripeException

      • usageRecordSummaries

        public UsageRecordSummaryCollection usageRecordSummaries()
                                                  throws StripeException
        For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

        The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

        Throws:
        StripeException

      • usageRecordSummaries

        public UsageRecordSummaryCollection usageRecordSummaries​(java.util.Map<java.lang.String,​java.lang.Object> params)
                                                  throws StripeException
        For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

        The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

        Throws:
        StripeException

      • usageRecordSummaries

        public UsageRecordSummaryCollection usageRecordSummaries​(java.util.Map<java.lang.String,​java.lang.Object> params,
                                                         RequestOptions options)
                                                  throws StripeException
        For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

        The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

        Throws:
        StripeException

      • usageRecordSummaries

        public UsageRecordSummaryCollection usageRecordSummaries​(SubscriptionItemUsageRecordSummariesParams params)
                                                  throws StripeException
        For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

        The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

        Throws:
        StripeException

      • usageRecordSummaries

        public UsageRecordSummaryCollection usageRecordSummaries​(SubscriptionItemUsageRecordSummariesParams params,
                                                         RequestOptions options)
                                                  throws StripeException
        For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that’s been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).

        The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn’t ended yet. Since new usage records can still be added, the returned summary information for the subscription item’s ID should be seen as unstable until the subscription billing period ends.

        Throws:
        StripeException

      • getBillingThresholds

        public SubscriptionItem.BillingThresholds getBillingThresholds()
        Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period.

      • getCreated

        public java.lang.Long getCreated()
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • getDeleted

        public java.lang.Boolean getDeleted()
        Always true for a deleted object.

      • getObject

        public java.lang.String getObject()
        String representing the object's type. Objects of the same type share the same value.

        Equal to subscription_item.

      • getPlan

        public Plan getPlan()
        You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

        Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.

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

        Related guides: Set up a subscription and more about products and prices.

      • getPrice

        public Price getPrice()
        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.

      • getQuantity

        public java.lang.Long getQuantity()
        The quantity of the plan to which the customer should be subscribed.

      • getSubscription

        public java.lang.String getSubscription()
        The subscription this subscription_item belongs to.

      • getTaxRates

        public java.util.List<TaxRate> getTaxRates()
        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.

      • setBillingThresholds

        public void setBillingThresholds​(SubscriptionItem.BillingThresholds billingThresholds)
        Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period.

      • setCreated

        public void setCreated​(java.lang.Long created)
        Time at which the object was created. Measured in seconds since the Unix epoch.

      • setDeleted

        public void setDeleted​(java.lang.Boolean deleted)
        Always true for a deleted object.

      • setId

        public void setId​(java.lang.String id)
        Unique identifier for the object.

      • setMetadata

        public void setMetadata​(java.util.Map<java.lang.String,​java.lang.String> 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.

      • setObject

        public void setObject​(java.lang.String object)
        String representing the object's type. Objects of the same type share the same value.

        Equal to subscription_item.

      • setPlan

        public void setPlan​(Plan plan)
        You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

        Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.

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

        Related guides: Set up a subscription and more about products and prices.

      • setPrice

        public void setPrice​(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.

      • setQuantity

        public void setQuantity​(java.lang.Long quantity)
        The quantity of the plan to which the customer should be subscribed.

      • setSubscription

        public void setSubscription​(java.lang.String subscription)
        The subscription this subscription_item belongs to.

      • setTaxRates

        public void setTaxRates​(java.util.List<TaxRate> taxRates)
        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.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Unique identifier for the object.
        Specified by:
        getId in interface HasId

      • getMetadata

        public java.util.Map<java.lang.String,​java.lang.String> getMetadata()
        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.
        Specified by:
        getMetadata in interface MetadataStore<SubscriptionItem>