v1

latestOpenAPI 3.0.0Proprietary2026-07-1313647393.0 KB

Plans

Create a plan

Define a recurring billing plan with a fixed period, interval, and amount. Plans are reusable across multiple subscriptions. Once created, plan details cannot be modified.

post/plans

Request body

period'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required

Billing frequency unit. For daily, minimum interval is 7.

intervalinteger required

Number of periods between charges (e.g. interval=3, period=monthly → charge every 3 months).

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

Response

Plan created.

idstring

Plan ID. Prefix: plan_

entity'plan'

intervalinteger

Number of periods between charges. For daily period, minimum interval is 7.

period'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly'

Billing frequency unit. daily requires interval ≥ 7.

notesNotes

Key-value pairs for storing custom metadata. Maximum 15 pairs. Each key and value must not exceed 256 characters.

created_atinteger