Class/Object

org.mdedetrich.stripe.v1.Plans

Plan

Related Docs: object Plan | package Plans

Permalink

case class Plan(id: String, amount: BigDecimal, created: OffsetDateTime, currency: Currency, interval: Interval, intervalCount: Long, livemode: Boolean, metadata: Option[Map[String, String]], name: String, statementDescriptor: Option[String], trialPeriodDays: Option[Long]) extends Product with Serializable

amount

The amount in cents to be charged on the interval specified

currency

Currency in which subscription will be charged

interval

One of Interval.Day, Interval.Week, Interval.Month or Interval.Year. The frequency with which a subscription should be billed.

intervalCount

The number of intervals (specified in the interval property) between each subscription billing. For example, \interval=Interval.Month and intervalCount=3 bills every 3 months.

metadata

A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about the plan in a structured format.

name

Display name of the plan

statementDescriptor

Extra information about a charge for the customer’s credit card statement.

trialPeriodDays

Number of trial period days granted when subscribing a customer to this plan. None if the plan has no trial period.

See also

https://stripe.com/docs/api#plan_object

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Plan
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Plan(id: String, amount: BigDecimal, created: OffsetDateTime, currency: Currency, interval: Interval, intervalCount: Long, livemode: Boolean, metadata: Option[Map[String, String]], name: String, statementDescriptor: Option[String], trialPeriodDays: Option[Long])

    Permalink

    amount

    The amount in cents to be charged on the interval specified

    currency

    Currency in which subscription will be charged

    interval

    One of Interval.Day, Interval.Week, Interval.Month or Interval.Year. The frequency with which a subscription should be billed.

    intervalCount

    The number of intervals (specified in the interval property) between each subscription billing. For example, \interval=Interval.Month and intervalCount=3 bills every 3 months.

    metadata

    A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about the plan in a structured format.

    name

    Display name of the plan

    statementDescriptor

    Extra information about a charge for the customer’s credit card statement.

    trialPeriodDays

    Number of trial period days granted when subscribing a customer to this plan. None if the plan has no trial period.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val amount: BigDecimal

    Permalink

    The amount in cents to be charged on the interval specified

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val created: OffsetDateTime

    Permalink
  8. val currency: Currency

    Permalink

    Currency in which subscription will be charged

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. val id: String

    Permalink
  13. val interval: Interval

    Permalink

    One of Interval.Day, Interval.Week, Interval.Month or Interval.Year.

    One of Interval.Day, Interval.Week, Interval.Month or Interval.Year. The frequency with which a subscription should be billed.

  14. val intervalCount: Long

    Permalink

    The number of intervals (specified in the interval property) between each subscription billing.

    The number of intervals (specified in the interval property) between each subscription billing. For example, \interval=Interval.Month and intervalCount=3 bills every 3 months.

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. val livemode: Boolean

    Permalink
  17. val metadata: Option[Map[String, String]]

    Permalink

    A set of key/value pairs that you can attach to a plan object.

    A set of key/value pairs that you can attach to a plan object. It can be useful for storing additional information about the plan in a structured format.

  18. val name: String

    Permalink

    Display name of the plan

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. val statementDescriptor: Option[String]

    Permalink

    Extra information about a charge for the customer’s credit card statement.

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. val trialPeriodDays: Option[Long]

    Permalink

    Number of trial period days granted when subscribing a customer to this plan.

    Number of trial period days granted when subscribing a customer to this plan. None if the plan has no trial period.

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped