Subscription

applicationFeePercent: A positive decimal that represents the fee percentage of the subscription invoice amount that will be transferred to the application owner’s Stripe account each billing period.
cancelAtPeriodEnd: If the subscription has been canceled with the at_period_end flag set to true, cancelAtPeriodEnd on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
canceledAt: If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancelAtPeriodEnd, canceledAt will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
currentPeriodEnd: End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
currentPeriodStart: Start of the current period that the subscription has been invoiced for
discount: Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
endedAt: If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended
metadata: A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.
plan: Hash describing the plan the customer is subscribed to
start: Date the subscription started
status: Possible values are Status.Trialing, Status.Active, Status.PastDue, Status.Canceled, or Status.Unpaid. A subscription still in its trial period is trialing and moves to active when the trial period is over. When payment to renew the subscription fails, the subscription becomes Status.PastDue. After Stripe has exhausted all payment retry attempts, the subscription ends up with a status of either Status.Canceled or Status.Unpaid depending on your retry settings. Note that when a subscription has a status of Status.Unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed. Additionally, updating customer card details will not lead to Stripe retrying the latest invoice.). After receiving updated card details from a customer, you may choose to reopen and pay their closed invoices.
taxPercent: If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.
trialEnd: If the subscription has a trial, the end of that trial.
trialStart: If the subscription has a trial, the beginning of that trial.

See also: https://stripe.com/docs/api#subscription_object

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Subscription(id: String, applicationFeePercent: Option[BigDecimal], cancelAtPeriodEnd: Boolean, canceledAt: Option[OffsetDateTime], currentPeriodEnd: OffsetDateTime, currentPeriodStart: OffsetDateTime, customer: String, discount: Option[Discount], endedAt: Option[OffsetDateTime], metadata: Option[Map[String, String]], plan: Plan, quantity: Long, start: OffsetDateTime, status: Status, taxPercent: Option[BigDecimal], trialEnd: Option[OffsetDateTime], trialStart: Option[OffsetDateTime])

applicationFeePercent
A positive decimal that represents the fee percentage of the subscription invoice amount that will be transferred to the application owner’s Stripe account each billing period.
cancelAtPeriodEnd
If the subscription has been canceled with the at_period_end flag set to true, cancelAtPeriodEnd on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
canceledAt
If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancelAtPeriodEnd, canceledAt will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
currentPeriodEnd
End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
currentPeriodStart
Start of the current period that the subscription has been invoiced for
discount
Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
endedAt
If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended
metadata
A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.
plan
Hash describing the plan the customer is subscribed to
start
Date the subscription started
status
Possible values are Status.Trialing, Status.Active, Status.PastDue, Status.Canceled, or Status.Unpaid. A subscription still in its trial period is trialing and moves to active when the trial period is over. When payment to renew the subscription fails, the subscription becomes Status.PastDue. After Stripe has exhausted all payment retry attempts, the subscription ends up with a status of either Status.Canceled or Status.Unpaid depending on your retry settings. Note that when a subscription has a status of Status.Unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed. Additionally, updating customer card details will not lead to Stripe retrying the latest invoice.). After receiving updated card details from a customer, you may choose to reopen and pay their closed invoices.
taxPercent
If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.
trialEnd
If the subscription has a trial, the end of that trial.
trialStart
If the subscription has a trial, the beginning of that trial.

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
val applicationFeePercent: Option[BigDecimal]

A positive decimal that represents the fee percentage of the subscription invoice amount that will be transferred to the application owner’s Stripe account each billing period.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val cancelAtPeriodEnd: Boolean

If the subscription has been canceled with the at_period_end flag set to true, cancelAtPeriodEnd on the subscription will be true.
If the subscription has been canceled with the at_period_end flag set to true, cancelAtPeriodEnd on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
val canceledAt: Option[OffsetDateTime]

If the subscription has been canceled, the date of that cancellation.
If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with cancelAtPeriodEnd, canceledAt will still reflect the date of the initial cancellation request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
def clone(): AnyRef

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

End of the current period that the subscription has been invoiced for.
End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
val currentPeriodStart: OffsetDateTime

Start of the current period that the subscription has been invoiced for
val customer: String
val discount: Option[Discount]

Describes the current discount applied to this subscription, if there is one.
Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
val endedAt: Option[OffsetDateTime]

If the subscription has ended (either because it was canceled or because the customer was switched to a subscription to a new plan), the date the subscription ended
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val id: String
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val metadata: Option[Map[String, String]]

A set of key/value pairs that you can attach to a subscription object.
A set of key/value pairs that you can attach to a subscription object. It can be useful for storing additional information about the subscription in a structured format.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val plan: Plan

Hash describing the plan the customer is subscribed to
val quantity: Long
val start: OffsetDateTime

Date the subscription started
val status: Status

Possible values are Status.Trialing, Status.Active, Status.PastDue, Status.Canceled, or Status.Unpaid.
Possible values are Status.Trialing, Status.Active, Status.PastDue, Status.Canceled, or Status.Unpaid. A subscription still in its trial period is trialing and moves to active when the trial period is over. When payment to renew the subscription fails, the subscription becomes Status.PastDue. After Stripe has exhausted all payment retry attempts, the subscription ends up with a status of either Status.Canceled or Status.Unpaid depending on your retry settings. Note that when a subscription has a status of Status.Unpaid, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed. Additionally, updating customer card details will not lead to Stripe retrying the latest invoice.). After receiving updated card details from a customer, you may choose to reopen and pay their closed invoices.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val taxPercent: Option[BigDecimal]

If provided, each invoice created by this subscription will apply the tax rate, increasing the amount billed to the customer.
val trialEnd: Option[OffsetDateTime]

If the subscription has a trial, the end of that trial.
val trialStart: Option[OffsetDateTime]

If the subscription has a trial, the beginning of that trial.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Subscription | package Subscriptions

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val applicationFeePercent: Option[BigDecimal]

final def asInstanceOf[T0]: T0

val cancelAtPeriodEnd: Boolean

val canceledAt: Option[OffsetDateTime]

def clone(): AnyRef

val currentPeriodEnd: OffsetDateTime

val currentPeriodStart: OffsetDateTime

val customer: String

val discount: Option[Discount]

val endedAt: Option[OffsetDateTime]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val id: String

final def isInstanceOf[T0]: Boolean

val metadata: Option[Map[String, String]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val plan: Plan

val quantity: Long

val start: OffsetDateTime

val status: Status

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

val taxPercent: Option[BigDecimal]

val trialEnd: Option[OffsetDateTime]

val trialStart: Option[OffsetDateTime]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped