Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →
The plan object
Fields
Section titled “Fields”| Field | Type | Always present | What it means |
|---|---|---|---|
id |
string | Yes | |
tenant_id |
string | No | |
code |
string | Yes | |
name |
string | Yes | |
currency |
string | Yes | |
billing_interval |
enum | Yes | One of: monthly, yearly. |
status |
enum | Yes | One of: active, archived. |
base_amount_cents |
integer (int64) | Yes | |
base_bill_timing |
enum | Yes | When the recurring base fee is invoiced relative to the period it covers. in_arrears: base + usage billed at period end. in_advance: base billed at period start (day 1 on create; cycle-close invoice carries upcoming period’s base + elapsed period’s usage). Usage lines are always arrears regardless of this field. A plan with no base fee is in_arrears. See ADR-031. One of: in_advance, in_arrears. |
prices |
array of Plan price | Yes | The plan’s usage prices from now on. A plan’s meters are the meters it has a price for. |
description |
string | No | |
tax_code |
string | No | Stripe tax code for this plan. Absent means the tenant’s default_product_tax_code. |
created_at |
string (date-time) | Yes | |
updated_at |
string (date-time) | Yes |