Plan

A priced package of one product. A plan last edited in the dashboard rather than through the API shows its pricing as a monthly Platform fee (RecurringPerUnit) carrying its included credits and overage price, plus a UsagePrepaidCredits charge for each event that uses credits; those attributes' productAttributeIds are made from the plan ID (plan_…-platform-fee, plan_…-<eventName>).

archivedAt
Type: string | nullFormat: date-time
required

When the plan was archived; null while it is active.
attributes
Type:
required

The plan's price for each product attribute it includes.

Properties: 5
createdAt
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
externalId
Type: string | null
required

Your ID for the plan, unique across your plans.
id
Type: string
required

The plan's Spondo Billing ID.
isDefault
Type: boolean
required

Whether this is the product's default plan, used when an order or checkout names the product but no plan.
name
Type: string
required
productId
Type: string | null
required

The product the plan prices. Null for a plan made in the dashboard without one.
status
Type: "active" or "archived"enum
required

active: on offer. archived: no longer offered; it is never picked as the product's default, and orders already on it carry on.
supportedCurrencies
Type: array of string
required

The currencies the plan is sold in (ISO 4217). The first is its main currency, the one its fee and credits are worked out in.
updatedAt
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
upgradePathOrder
Type: integer | null
min:
0
required

The plan's position in its upgrade path group, from 0 (the lowest plan). Null when it is in no group.

PricingUpdateInput

PlanAttribute