Plans

Type Members

1. sealed abstract class Interval extends EnumEntry

   

2. case class Plan(id: String, amount: BigDecimal, created: OffsetDateTime, currency: Currency, interval: Interval, intervalCount: Long, livemode: Boolean, name: String, metadata: Option[Map[String, String]] = None, statementDescriptor: Option[String] = None, trialPeriodDays: Option[Long] = None) 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.

   name

   Display name of the plan

   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.

   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. scala.None if the plan has no trial period.

   See also

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

3. case class PlanInput(id: String, amount: BigDecimal, currency: Currency, interval: Interval, name: String, intervalCount: Option[Long] = None, metadata: Option[Map[String, String]] = None, statementDescriptor: Option[String] = None, trialPeriodDays: Option[Long] = None) extends Product with Serializable

   
   id

   Unique string of your choice that will be used to identify this plan when subscribing a customer. This could be an identifier like “gold” or a primary key from your own database.

   amount

   A positive integer in cents (or 0 for a free plan) representing how much to charge (on a recurring basis).

   currency

   3-letter ISO code for currency.

   interval

   Specifies billing frequency. Either Interval.Day, Interval.Week, Interval.Month or Interval.Year.

   name

   Name of the plan, to be displayed on invoices and in the web interface.

   intervalCount

   The number of intervals between each subscription billing. For example, interval=Interval.Month and intervalCount=3 bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).

   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. This will be unset if you POST an empty value.

   statementDescriptor

   An arbitrary string to be displayed on your customer’s credit card statement. This may be up to 22 characters. As an example, if your website is RunClub and the item you’re charging for is your Silver Plan, you may want to specify a statementDescriptor of RunClub Silver Plan. The statement description may not include <>"' characters, and will appear on your customer’s statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all.

   trialPeriodDays

   Specifies a trial period in (an integer number of) days. If you include a trial period, the customer won’t be billed for the first time until the trial period ends. If the customer cancels before the trial period is over, she’ll never be billed at all.

   Exceptions thrown

   StatementDescriptorInvalidCharacter - If statementDescriptor has an invalid character

   StatementDescriptorTooLong - If statementDescriptor is longer than 22 characters

   See also

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

4. case class PlanList(url: String, hasMore: Boolean, data: List[Plan], totalCount: Option[Long]) extends List[Plan] with Product with Serializable

   

5. case class PlanListInput(created: Option[ListFilterInput] = None, endingBefore: Option[String] = None, limit: Option[Long] = None, startingAfter: Option[String] = None) extends Product with Serializable

   
   created

   A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:

   endingBefore

   A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

   limit

   A limit on the number of objects to be returned. Limit can range between 1 and 100 items.

   startingAfter

   A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next page of the list.

   See also

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

6. sealed abstract class Status extends EnumEntry