struct

Polar::Models::CustomerOrderSubscription

Inherits JSON::Serializable < Struct < Value < Object

Model representing a CustomerOrderSubscription

This struct is auto-generated from the Polar.sh OpenAPI specification. It uses JSON::Serializable for automatic JSON parsing and serialization.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

amount

The amount of the subscription.

Source
cancel_at_period_end

Whether the subscription will be canceled at the end of the current period.

Source
canceled_at

The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true.

Source
checkout_id
Source
created_at

Creation timestamp of the object.

Source
currency

The currency of the subscription.

Source
current_period_end

The end timestamp of the current billing period.

Source
current_period_start

The start timestamp of the current billing period.

Source
customer_cancellation_comment
Source
customer_cancellation_reason
Source
customer_id

The ID of the subscribed customer.

Source
discount_id

The ID of the applied discount, if any.

Source
ended_at

The timestamp when the subscription ended.

Source
ends_at

The timestamp when the subscription will end.

Source
id

The ID of the object.

Source
modified_at

Last modification timestamp of the object.

Source
product_id

The ID of the subscribed product.

Source
recurring_interval

The interval at which the subscription recurs.

Source
recurring_interval_count

Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on.

Source
seats

The number of seats for seat-based subscriptions. None for non-seat subscriptions.

Source
started_at

The timestamp when the subscription started.

Source
status

The status of the subscription.

Source
trial_end

The end timestamp of the trial period, if any.

Source
trial_start

The start timestamp of the trial period, if any.

Source