Plans

Columns

Name

Type

ReadOnly

References

Description

Id [KEY]

String

False

The Id of the plan.

Amount

Decimal

False

The amount in cents to be charged on the interval specified.

Created

Datetime

True

The creation date.

Currency

String

False

Currency in which subscription will be charged..

Nickname

String

False

A brief description of the plan, hidden from customers.

Product

String

False

The product whose pricing this plan determines.

Interval

String

False

One of day, week, month or year. The frequency with which a subscription should be billed.

The allowed values are day, week, month.

IntervalCount

Integer

False

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

TrialPeriodDays

Integer

False

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

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name

Type

Description

AccountId

String

The Id of the connected account to get plans for.

Last updated