Package com.stripe.model.v2.billing

Class PricingPlanSubscription

java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.billing.PricingPlanSubscription
All Implemented Interfaces:
HasId, StripeObjectInterface
public class PricingPlanSubscription extends StripeObject implements HasId

  • Constructor Details

    • PricingPlanSubscription

      public PricingPlanSubscription()

  • Method Details

    • getBillingCadence

      public String getBillingCadence()
      The ID of the Billing Cadence this subscription is billed on.

    • getCollectionStatus

      public String getCollectionStatus()
      Current collection status of this subscription.

      One of awaiting_customer_action, current, past_due, paused, or unpaid.

    • getCollectionStatusTransitions

      public PricingPlanSubscription.CollectionStatusTransitions getCollectionStatusTransitions()
      Timestamps for collection status transitions.

    • getCreated

      public Instant getCreated()
      Time at which the object was created.

    • getLivemode

      public 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 Map<String,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.

    • getObject

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

      Equal to v2.billing.pricing_plan_subscription.

    • getPricingPlan

      public String getPricingPlan()
      The ID of the Pricing Plan for this subscription.

    • getPricingPlanVersion

      public String getPricingPlanVersion()
      The ID of the Pricing Plan Version for this subscription.

    • getServicingStatus

      public String getServicingStatus()
      Current servicing status of this subscription.

      One of active, canceled, paused, or pending.

    • getServicingStatusTransitions

      public PricingPlanSubscription.ServicingStatusTransitions getServicingStatusTransitions()
      Timestamps for servicing status transitions.

    • getTestClock

      public String getTestClock()
      The ID of the Test Clock of the associated Billing Cadence, if any.

    • setBillingCadence

      public void setBillingCadence(String billingCadence)
      The ID of the Billing Cadence this subscription is billed on.

    • setCollectionStatus

      public void setCollectionStatus(String collectionStatus)
      Current collection status of this subscription.

      One of awaiting_customer_action, current, past_due, paused, or unpaid.

    • setCollectionStatusTransitions

      public void setCollectionStatusTransitions(PricingPlanSubscription.CollectionStatusTransitions collectionStatusTransitions)
      Timestamps for collection status transitions.

    • setCreated

      public void setCreated(Instant created)
      Time at which the object was created.

    • setId

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

    • setLivemode

      public void setLivemode(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(Map<String,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(String object)
      String representing the object's type. Objects of the same type share the same value of the object field.

      Equal to v2.billing.pricing_plan_subscription.

    • setPricingPlan

      public void setPricingPlan(String pricingPlan)
      The ID of the Pricing Plan for this subscription.

    • setPricingPlanVersion

      public void setPricingPlanVersion(String pricingPlanVersion)
      The ID of the Pricing Plan Version for this subscription.

    • setServicingStatus

      public void setServicingStatus(String servicingStatus)
      Current servicing status of this subscription.

      One of active, canceled, paused, or pending.

    • setServicingStatusTransitions

      public void setServicingStatusTransitions(PricingPlanSubscription.ServicingStatusTransitions servicingStatusTransitions)
      Timestamps for servicing status transitions.

    • setTestClock

      public void setTestClock(String testClock)
      The ID of the Test Clock of the associated Billing Cadence, if any.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

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