Skip to main content
GET
/
templates
/
plan
/
{plan_id}
Get plan by ID
curl --request GET \
  --url https://api.zenskar.com/templates/plan/{plan_id} \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "enterprise-plan",
  "display": {
    "title": "Enterprise Plan",
    "description": "Full-featured enterprise tier"
  },
  "version": 1,
  "is_latest_version": true,
  "duration": "P1Y",
  "renewal_config": {
    "auto_renew": true
  },
  "status": "active",
  "business_entity_id": "987fcdeb-51a2-43d7-9876-543210fedcba",
  "organization_id": "456e7890-e89b-12d3-a456-426614174111",
  "products": [
    {
      "id": "789e0123-e89b-12d3-a456-426614174222",
      "product_id": "aaa11111-e89b-12d3-a456-426614174333",
      "pricing_id": "bbb22222-e89b-12d3-a456-426614174444",
      "quantity_config": {
        "type": "fixed",
        "default": 1,
        "customer_configurable": false
      },
      "display_order": 0
    }
  ],
  "discounts": [],
  "taxes": [],
  "commitments": [],
  "created_at": "2025-01-01T10:30:00Z",
  "updated_at": "2025-01-15T14:20:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

plan_id
string<uuid>
required

Response

Plan retrieved successfully

Response schema for plan

Attributes: id: Plan ID name: Plan name display_config: Display configuration version: Version number parent_plan_id: Parent plan ID (for versioned plans) is_latest_version: Is this the latest version duration: Billing period renewal_config: Renewal configuration 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 provisioning_mode: Provisioning mode status: Plan status business_entity_id: Business entity ID organization_id: Organization ID products: List of plan products created_at: Creation timestamp updated_at: Last update timestamp

id
string<uuid>
required

Plan ID

name
string
required

Plan name

version
integer
required

Version number

is_latest_version
boolean
required

Is latest version

status
string
required

Plan status

currency
string
required

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

organization_id
string<uuid>
required

Organization ID

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

display_config
DisplaySchema · object

Display configuration

parent_plan_id
string<uuid> | null

Parent plan ID (for versions)

duration
string | null

Billing period (ISO 8601)

renewal_config
Renewal Config · object

Renewal configuration

custom_attributes
Custom Attributes · object

Custom metadata

trial_config
Trial Config · object

Trial configuration

discounts
Discount · object[] | null

Plan-wide discounts

taxes
Taxes · object[] | null

Tax configuration

commitments
Commitment · object[] | null

Commitment requirements

payment_config
Payment Config · object

Payment configuration

billing_config
BillingConfigSchema · object

Billing configuration

provisioning_mode
enum<string> | null

Provisioning mode (immediate, payment_method_validation, charge_on_acceptance, charge_when_due)

Available options:
immediate,
payment_method_validation,
charge_on_acceptance,
charge_when_due
business_entity_id
string<uuid> | null

Business entity ID

products
PlanProductV3ResponseSchema · object[] | null

List of plan products