Skip to main content

The plan a team is on, and the dates of its current billing term.

planName
string
required

Display name of the plan.

planType
string
required

Plan identifier in camelCase, for example businessTier1Annual or aiSdrEnterpriseAnnual. Treat this as an opaque string: the catalogue of plans runs to well over a hundred values and changes as plans are introduced and retired.

billingPeriod
enum<string>
required

How often the subscription renews.

Available options:
unknown,
month,
year,
quarterly,
semiAnnual
planState
enum<string>
required

Where the team sits between trialling Reply and being a paying customer.

Available options:
trial,
trialExpired,
customer,
closed,
secondTrial,
secondTrialExpired
subscriptionState
enum<string>
required

The standing of the subscription with the payment provider.

Available options:
none,
free,
active,
chargeFailure,
suspended,
nonRenewing,
canceled,
underReview,
blocked
startDate
string<date-time> | null

Start of the current billing term. For a team still trialling Reply and with no subscription yet, this is the start of the trial window instead.

endDate
string<date-time> | null

End of the current billing term. For a team still trialling Reply and with no subscription yet, this is the date the trial expires instead.

nextBillingDate
string<date-time> | null

When the subscription is next charged. Null when it does not renew, or when there is no subscription yet.