Plans define pricing and billing configurations for subscription products. Each plan specifies the amount, currency, billing interval, and optional trial period. Plans are associated with products and can include entitlements that grant access to specific content or features.
| Type | Description |
|---|
regular | Standard subscription plan |
membership | Group/institutional subscription with seat limit (member_seat_capacity) |
| Interval | Description |
|---|
day | Daily billing |
week | Weekly billing |
month | Monthly billing |
year | Annual billing |
Use interval_count to specify multiples (e.g. interval: month, interval_count: 3 for quarterly).
| Strategy | Description |
|---|
regular | Standard auto-renewal |
digital | Digital-only renewal |
agency | Agency-managed renewal |
single_shipment | Expires after one shipment |
| Attribute | Type | Description |
|---|
id | integer | Unique identifier |
active | string | Plan status: active or archived |
agency_id | integer | Managing agency ID |
product_id | integer | Parent product ID |
status | string | Alias for active (deprecated) |
agency_remit_rate | number | Percentage remitted to agency |
amount | integer | Price in cents |
apple_product_id | string | Apple App Store product ID |
available_online | boolean | Whether available for online purchase |
auto_renew | boolean | Whether subscriptions auto-renew |
currency | string | Three-letter ISO currency code |
countries | array | Countries where plan is available |
description | string | Plan description |
domains | array | Email domains for auto-subscription |
entitlements | object | Access permissions granted |
group_owner_plan_id | integer | Parent plan ID for group plans |
gift_description | string | Description for gift purchases |
image | string | Plan image URL |
interval | string | Billing interval |
interval_count | integer | Intervals between billings |
ip_addresses | array | IP addresses for auto-subscription (CIDR) |
metadata | object | Custom key-value data |
nickname | string | Display name (max 255 chars) |
name_internal | string | Internal reference name |
renewal_strategy | string | Renewal behavior |
shipments_per_interval | integer | Shipments per billing cycle |
trial_period_days | integer | Free trial days (max 730) |
expires_at | string | Plan expiration date |
allow_send_invoice | boolean | Whether customers can pay via invoice |
is_donation | boolean | Whether plan is a donation |
is_hidden | boolean | Whether hidden from public display |
is_imported | boolean | Whether imported from external system |
type | string | regular or membership |
member_seat_capacity | integer | Max seats for membership plans |
refundable | boolean | Whether refunds are allowed |
auto_uncollectible_days | integer | Days before auto-marking uncollectible |
invoice_upcoming_notification | integer | Days before renewal to notify |
old_provider_id | string | External provider ID |
