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

Custom plan ID (optional)

string
required
length between 1 and 255

Plan name

display_config

Display configuration

ISO 8601 duration (P1M, P1Y)

renewal_config

Renewal configuration (open JSON for now)

custom_attributes

Custom metadata

trial_config

Trial configuration

discounts

Plan-wide discounts

taxes

Tax configuration

commitments

Commitment requirements

payment_config

Payment configuration

billing_config

Billing configuration

string
enum

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

Allowed:
enum

Plan status

string
required

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

Business entity ID

products

Products to add to plan

Responses

Updated 4 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 4 days ago