API Reference
Book a Demo

Create plan

post
https://api.zenskar.com/templates/plan

Creates a new plan in Zenskar. Plans define pricing structures and product combinations that can be offered to customers through contracts or subscriptions.

A plan includes products with pricing models, optional discounts, taxes, and commitments. Plans start as DRAFT by default and can be activated when ready.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request schema for creating a plan

Attributes: id: Optional custom ID (auto-generated if not provided) name: Internal plan identifier display_config: Customer-facing display content duration: Billing period in ISO 8601 format (P1M, P1Y, etc.) renewal_config: Auto-renewal configuration custom_attributes: Custom metadata trial_config: Trial period configuration discounts: Plan-wide discounts (matches product pricing schema) taxes: Tax configuration (matches product pricing schema) commitments: Commitment requirements (matches product pricing schema) payment_config: Payment method requirements billing_config: Billing cycle anchor configuration provisioning_config: Provisioning configuration for contract creation status: Plan status (default: DRAFT) business_entity_id: Business entity for invoicing products: List of products to add to plan

Custom plan ID (optional)

string
required
length between 1 and 255

Plan name

DisplaySchema | null

Display configuration

ISO 8601 duration (P1M, P1Y)

object | null

Renewal configuration (open JSON for now)

object | null

Custom metadata

TrialConfigSchema | null

Trial configuration

array | null

Plan-wide discounts

array | null

Tax configuration

array | null

Commitment requirements

ContractPaymentConfig | null

Payment configuration

BillingConfigSchema | null

Billing configuration

string
enum

Provisioning mode determining when/how contract is created (immediate, payment_method_validation, charge_on_acceptance, charge_when_due)

Allowed:
PlanStatus | null

Plan status

string
required

Three-letter ISO 4217 currency code (e.g., 'USD', 'EUR', 'GBP')

Business entity ID

array | null

Products to add to plan

Responses

Updated 17 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago