Package com.stripe.model

Class SubscriptionSchedule

    • Constructor Detail

      • SubscriptionSchedule

        public SubscriptionSchedule()

    • Method Detail

      • getCustomer

        public java.lang.String getCustomer()
        Get id of expandable `customer` object.

      • setCustomer

        public void setCustomer​(java.lang.String id)

      • getCustomerObject

        public Customer getCustomerObject()
        Get expanded `customer`.

      • setCustomerObject

        public void setCustomerObject​(Customer expandableObject)

      • getSubscription

        public java.lang.String getSubscription()
        Get id of expandable `subscription` object.

      • setSubscription

        public void setSubscription​(java.lang.String id)

      • getSubscriptionObject

        public Subscription getSubscriptionObject()
        Get expanded `subscription`.

      • setSubscriptionObject

        public void setSubscriptionObject​(Subscription expandableObject)

      • getBilling

        public java.lang.String getBilling()
        Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.

      • getBillingThresholds

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

      • getCanceledAt

        public java.lang.Long getCanceledAt()
        Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

      • getCompletedAt

        public java.lang.Long getCompletedAt()
        Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

      • getCreated

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

      • getCurrentPhase

        public SubscriptionSchedule.CurrentPhase getCurrentPhase()
        Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.

      • getLivemode

        public java.lang.Boolean getLivemode()
        Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

      • 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<SubscriptionSchedule>

      • getObject

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

      • getReleasedAt

        public java.lang.Long getReleasedAt()
        Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

      • getReleasedSubscription

        public java.lang.String getReleasedSubscription()
        ID of the subscription once managed by the subscription schedule (if it is released).

      • getRenewalBehavior

        public java.lang.String getRenewalBehavior()
        Behavior of the subscription schedule and underlying subscription when it ends.

      • getRenewalInterval

        public SubscriptionSchedule.RenewalInterval getRenewalInterval()
        Interval and duration at which the subscription schedule renews for when it ends if `renewal_behavior` is `renew`.

      • getRevision

        public java.lang.String getRevision()
        ID of the current revision of the subscription schedule.

      • getStatus

        public java.lang.String getStatus()
        Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`.

      • setBilling

        public void setBilling​(java.lang.String billing)
        Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions.

      • setBillingThresholds

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

      • setCanceledAt

        public void setCanceledAt​(java.lang.Long canceledAt)
        Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.

      • setCompletedAt

        public void setCompletedAt​(java.lang.Long completedAt)
        Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.

      • setCreated

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

      • setCurrentPhase

        public void setCurrentPhase​(SubscriptionSchedule.CurrentPhase currentPhase)
        Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.

      • setId

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

      • setLivemode

        public void setLivemode​(java.lang.Boolean livemode)
        Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

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

      • setPhases

        public void setPhases​(java.util.List<SubscriptionSchedule.Phase> phases)
        Configuration for the subscription schedule's phases.

      • setReleasedAt

        public void setReleasedAt​(java.lang.Long releasedAt)
        Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.

      • setReleasedSubscription

        public void setReleasedSubscription​(java.lang.String releasedSubscription)
        ID of the subscription once managed by the subscription schedule (if it is released).

      • setRenewalBehavior

        public void setRenewalBehavior​(java.lang.String renewalBehavior)
        Behavior of the subscription schedule and underlying subscription when it ends.

      • setRenewalInterval

        public void setRenewalInterval​(SubscriptionSchedule.RenewalInterval renewalInterval)
        Interval and duration at which the subscription schedule renews for when it ends if `renewal_behavior` is `renew`.

      • setRevision

        public void setRevision​(java.lang.String revision)
        ID of the current revision of the subscription schedule.

      • setStatus

        public void setStatus​(java.lang.String status)
        Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`.

      • 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