Logo
Search
Docs

Fields & validation

Request rules and important response fields.

Write validation

EndpointFieldRules
upgrade / subscribepackage_idrequired|exists:subscription_packages,id
checkout createpackage_idrequired|exists:subscription_packages,id
checkout createpayment_method_idrequired|string
checkout createbilling_intervalnullable|string|in:monthly,yearly (default monthly)

billing sibling

source (self|workspace_owner), workspace_id, workspace_name, can_manage_billing (bool).

Subscription wire keys

Full subscription rows may include stripe_subscription_id, stripe_customer_id, stripe_checkout_session_id, payment_link_id, payment_link_url, checkout_session_url, and metadata. The compact GET /subscriptions/{id} projection only returns id, package_name, amount, status, valid_until, created_at.