> ## Documentation Index
> Fetch the complete documentation index at: https://alguna.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a plan

> Creates a new plan with its full pricing template — name, currency, contract configuration, and the items (standalone priced products and/or bundles) that subscriptions will inherit. Optional fields cover plan-level discount, spend thresholds, price escalation, entitlements, tags, and invoice/email behavior.



## OpenAPI

````yaml /api-reference/v2/specs/2026-04-01.json post /plans
openapi: 3.1.0
info:
  title: Alguna Public API
  version: '2026-04-01'
servers:
  - url: https://api.alguna.io
security:
  - bearerAuth: []
tags:
  - name: Billing Events and Metrics
  - name: Credit Notes
  - name: Credits
  - name: Customer Portal Sessions
  - name: Customers
  - name: Insights
  - name: Invoices
  - name: Payments
  - name: Plans
  - name: Product Bundles
  - name: Products
  - name: Refunds
  - name: Revenue Schedules
  - name: Subscription Changes
  - name: Subscription Versions
  - name: Subscriptions
  - name: Wallet Grants
  - name: Wallets
paths:
  /plans:
    post:
      tags:
        - Plans
      summary: Create a plan
      description: >-
        Creates a new plan with its full pricing template — name, currency,
        contract configuration, and the items (standalone priced products and/or
        bundles) that subscriptions will inherit. Optional fields cover
        plan-level discount, spend thresholds, price escalation, entitlements,
        tags, and invoice/email behavior.
      operationId: create-plan
      parameters:
        - in: header
          name: Alguna-Version
          required: true
          schema:
            enum:
              - '2026-04-01'
            type: string
        - in: header
          name: Idempotency-Key
          schema:
            description: >-
              A unique string used to ensure the request is processed exactly
              once. If you retry a request with the same idempotency key within
              24 hours, the original response is returned without re-executing
              the operation.
            example: ik_a1b2c3d4e5f6
            maxLength: 255
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePlanRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlanResponse'
          description: Success
          headers:
            Idempotency-Key:
              description: Echo of the idempotency key provided in the request
              schema:
                type: string
            Idempotent-Replayed:
              description: >-
                Whether this response was replayed from a previous request
                (true) or freshly executed (false)
              schema:
                type: boolean
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Conflict — a request with this idempotency key is currently being
            processed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
components:
  schemas:
    CreatePlanRequest:
      properties:
        additional_terms:
          description: Markdown additional terms appended to the contract
          nullable: true
          type: string
        auto_activate:
          description: Auto-activate subscriptions created from this plan
          example: false
          nullable: true
          type: boolean
        auto_renew:
          description: Whether the plan auto-renews
          example: true
          nullable: true
          type: boolean
        contract_duration:
          description: Contract duration in months
          example: 12
          format: int64
          nullable: true
          type: integer
        contract_period_type:
          description: Contract period type
          enum:
            - fixed
            - monthly_rolling
          example: fixed
          nullable: true
          type: string
        currency:
          description: ISO 4217 currency code
          example: USD
          type: string
        description:
          description: Plan description
          example: Full-featured enterprise plan
          type: string
        discount:
          allOf:
            - $ref: '#/components/schemas/DiscountInput'
          description: Plan-level discount applied across the price set
          nullable: true
        entitlements:
          description: Entitlement configs to provision with the plan
          items:
            $ref: '#/components/schemas/EntitlementInput'
          type: array
        invoice_settings:
          allOf:
            - $ref: '#/components/schemas/CreatePlanInvoiceSettingsInput'
          description: Invoice/email behavior overrides for the plan
          nullable: true
        items:
          description: >-
            Items that make up the plan's pricing template. Each item is either
            a standalone product (product_id + price) or a bundle (bundle_id +
            name + items).
          items:
            $ref: '#/components/schemas/CreatePlanItemInput'
          type: array
        maximum_spend:
          allOf:
            - $ref: '#/components/schemas/SpendingThresholdInput'
          description: Maximum spend per period
          nullable: true
        minimum_spend:
          allOf:
            - $ref: '#/components/schemas/SpendingThresholdInput'
          description: Minimum spend per period
          nullable: true
        name:
          description: Plan name
          example: Enterprise Plan
          type: string
        payment_terms:
          description: Invoice payment terms
          example: net_30
          nullable: true
          type: string
        price_escalation:
          allOf:
            - $ref: '#/components/schemas/PriceEscalationInput'
          description: Price escalation config
          nullable: true
        renewal_duration:
          description: Renewal duration in months
          example: 12
          format: int64
          nullable: true
          type: integer
        renewal_period_type:
          description: Renewal period type
          enum:
            - fixed
            - monthly_rolling
          nullable: true
          type: string
        tags:
          description: Tag IDs to associate with the plan
          example:
            - tag_abc123
          items:
            type: string
          type: array
        trial_period_days:
          description: Trial period in days
          example: 14
          format: int64
          nullable: true
          type: integer
      required:
        - currency
        - name
      type: object
    PlanResponse:
      properties:
        created_at:
          description: Timestamp when the plan was created
          example: '2026-04-01T10:00:00Z'
          format: date-time
          type: string
        currency:
          description: The currency in which the plan is billed
          example: USD
          type: string
        description:
          description: A brief description of the plan
          example: Full-featured enterprise plan
          nullable: true
          type: string
        id:
          description: Unique identifier for the plan
          example: pln_01H1VECT
          type: string
        name:
          description: The name of the plan
          example: Enterprise Plan
          type: string
        updated_at:
          description: Timestamp when the plan was last updated
          example: '2026-04-01T12:30:00Z'
          format: date-time
          type: string
      required:
        - created_at
        - currency
        - id
        - name
        - updated_at
      type: object
    ErrorResponse:
      properties:
        detail:
          type: string
        status:
          format: int64
          type: integer
      required:
        - status
        - detail
      type: object
    DiscountInput:
      properties:
        amount:
          description: Discount amount
          example: '10'
          type: string
        duration_type:
          description: Duration type
          enum:
            - fixed
            - monthly_rolling
          example: fixed
          type: string
        duration_unit:
          description: Duration unit
          example: months
          nullable: true
          type: string
        duration_value:
          description: Duration value
          example: 6
          format: int64
          nullable: true
          type: integer
        type:
          description: Discount type (percentage only for subscription-level)
          example: percentage
          type: string
      required:
        - amount
        - duration_type
        - type
      type: object
    EntitlementInput:
      properties:
        allocation:
          allOf:
            - $ref: '#/components/schemas/EntitlementAllocationInput'
          description: Credit allocation config (required for credit_allocation type)
          nullable: true
        entitlement_key:
          description: Entitlement key
          example: api_access
          type: string
        mode:
          description: Entitlement mode
          enum:
            - static
            - grant_based
          example: static
          type: string
        timing:
          allOf:
            - $ref: '#/components/schemas/EntitlementTimingInput'
          description: Timing config (for grant-based entitlements)
          nullable: true
        type:
          description: Entitlement type
          enum:
            - boolean
            - number
            - string
            - credit_allocation
          example: boolean
          type: string
        value:
          description: Entitlement value (for boolean/number/string types)
          example: 'true'
          type: string
      required:
        - entitlement_key
        - mode
        - type
      type: object
    CreatePlanInvoiceSettingsInput:
      properties:
        auto_issue_invoices:
          description: Whether to auto-issue invoices
          example: true
          nullable: true
          type: boolean
        auto_pay_invoices:
          description: Whether to auto-pay invoices
          example: false
          nullable: true
          type: boolean
        invoice_footer_text:
          description: Footer text applied to invoices
          example: Questions? support@example.com
          nullable: true
          type: string
        invoice_memo_template:
          description: Template applied to invoice memos
          example: Thanks for your business
          nullable: true
          type: string
        send_activation_email:
          description: Whether to send an activation email
          example: true
          nullable: true
          type: boolean
        send_invoices_to_customer:
          description: Whether to email invoices to the customer
          example: true
          nullable: true
          type: boolean
        send_receipts_to_customer:
          description: Whether to email receipts to the customer
          example: true
          nullable: true
          type: boolean
      type: object
    CreatePlanItemInput:
      properties:
        bundle_description:
          description: Description for the bundle (bundle items only)
          example: Premium support and SSO
          nullable: true
          type: string
        bundle_id:
          description: Source bundle ID (for bundle items)
          example: bun_abc123
          nullable: true
          type: string
        items:
          description: Bundle child items (for bundle items)
          items:
            $ref: '#/components/schemas/CreatePlanBundleChildItemInput'
          type: array
        name:
          description: Display name for the bundle (bundle items only)
          example: Enterprise Add-ons
          nullable: true
          type: string
        price:
          allOf:
            - $ref: '#/components/schemas/PriceInput'
          description: Price definition (for standalone items)
          nullable: true
        product_id:
          description: Product ID (for standalone items)
          example: prod_abc123
          nullable: true
          type: string
      type: object
    SpendingThresholdInput:
      properties:
        amount:
          description: Amount
          example: '500.00'
          type: string
        period:
          description: Billing period
          enum:
            - monthly
            - quarterly
            - semi_annual
            - yearly
          example: monthly
          type: string
      required:
        - amount
        - period
      type: object
    PriceEscalationInput:
      properties:
        enabled:
          description: Whether price escalation is enabled
          example: true
          type: boolean
        escalate_metered_unit_rates:
          description: Whether to escalate metered unit rates
          example: false
          nullable: true
          type: boolean
        interval_months:
          description: Months between escalations
          example: 12
          format: int64
          type: integer
        percentage:
          description: Escalation percentage
          example: '5.00'
          nullable: true
          type: string
        type:
          description: Escalation type
          example: percentage
          type: string
      required:
        - enabled
        - interval_months
        - type
      type: object
    EntitlementAllocationInput:
      properties:
        amount:
          description: Allocation amount
          example: '100000'
          type: string
        credit_type:
          description: Credit type
          enum:
            - monetary
            - units
          example: monetary
          type: string
        rollover_enabled:
          description: Whether rollover is enabled
          example: true
          type: boolean
        rollover_max_periods:
          description: Maximum rollover periods
          example: 3
          format: int64
          nullable: true
          type: integer
      required:
        - amount
        - credit_type
        - rollover_enabled
      type: object
    EntitlementTimingInput:
      properties:
        interval:
          description: Timing interval
          enum:
            - monthly
            - quarterly
            - semi_annual
            - yearly
          example: monthly
          nullable: true
          type: string
        recurrence:
          description: Recurrence type
          enum:
            - recurring
            - one_off
          example: recurring
          type: string
      required:
        - recurrence
      type: object
    CreatePlanBundleChildItemInput:
      properties:
        price:
          allOf:
            - $ref: '#/components/schemas/PriceInput'
          description: Price definition
        product_id:
          description: Product ID
          example: prod_abc123
          type: string
      required:
        - price
        - product_id
      type: object
    PriceInput:
      properties:
        billing_direction:
          description: Billing direction
          enum:
            - advance
            - arrears
          example: arrears
          type: string
        billing_frequency:
          description: Billing frequency (required for fixed fee type)
          enum:
            - recurring
            - one-off
          example: recurring
          nullable: true
          type: string
        billing_interval:
          description: Legacy named billing interval
          enum:
            - monthly
            - quarterly
            - semi_annual
            - yearly
          example: monthly
          type: string
        billing_interval_count:
          description: Positive count of BillingIntervalUnits per period
          example: 3
          format: int64
          nullable: true
          type: integer
        billing_interval_unit:
          description: Unit of the billing cadence (currently only 'month' accepted)
          enum:
            - day
            - week
            - month
            - year
          example: month
          nullable: true
          type: string
        charge_on_contract_start:
          description: Whether to charge on contract start
          example: false
          nullable: true
          type: boolean
        discount:
          allOf:
            - $ref: '#/components/schemas/DiscountInput'
          description: Price-level discount
          nullable: true
        display_order:
          description: Display order
          example: 1
          format: int64
          nullable: true
          type: integer
        expression_pricing_model:
          allOf:
            - $ref: '#/components/schemas/ExpressionPricingModelInput'
          description: Expression pricing model (required when type=expression)
          nullable: true
        fee_type:
          description: Fee type
          enum:
            - fixed
            - metered
          example: fixed
          type: string
        fixed_pricing_model:
          allOf:
            - $ref: '#/components/schemas/FixedPricingModelInput'
          description: Fixed pricing model (required when type=fixed)
          nullable: true
        graduated_percentage_pricing_model:
          allOf:
            - $ref: '#/components/schemas/GraduatedPercentagePricingModelInput'
          description: >-
            Graduated percentage pricing model (required when
            type=graduated_percentage)
          nullable: true
        graduated_tiered_pricing_model:
          allOf:
            - $ref: '#/components/schemas/GraduatedTieredPricingModelInput'
          description: Graduated tiered pricing model (required when type=graduated_tiered)
          nullable: true
        maximum_spend:
          allOf:
            - $ref: '#/components/schemas/SpendingThresholdInput'
          description: Maximum spend per period
          nullable: true
        metric_ids:
          description: Metric IDs (required for metered fee type)
          items:
            type: string
          type: array
        minimum_spend:
          allOf:
            - $ref: '#/components/schemas/SpendingThresholdInput'
          description: Minimum spend per period
          nullable: true
        prepaid_fixed_tiered_pricing_model:
          allOf:
            - $ref: '#/components/schemas/PrepaidFixedTieredPricingModelInput'
          description: >-
            Prepaid fixed tiered pricing model (required when
            type=prepaid_fixed_tiered)
          nullable: true
        prepaid_tiered_pricing_model:
          allOf:
            - $ref: '#/components/schemas/PrepaidTieredPricingModelInput'
          description: Prepaid tiered pricing model (required when type=prepaid_tiered)
          nullable: true
        recurring_instalment_interval_count:
          description: >-
            Positive count of RecurringInstalmentIntervalUnits per instalment;
            must divide cleanly into the billing interval
          example: 1
          format: int64
          nullable: true
          type: integer
        recurring_instalment_interval_unit:
          description: >-
            Optional sub-cadence unit splitting the advance charge into
            instalments within each billing cycle (currently only 'month'
            accepted)
          enum:
            - day
            - week
            - month
            - year
          example: month
          nullable: true
          type: string
        tiered_percentage_pricing_model:
          allOf:
            - $ref: '#/components/schemas/TieredPercentagePricingModelInput'
          description: >-
            Tiered percentage pricing model (required when
            type=tiered_percentage)
          nullable: true
        tiered_pricing_model:
          allOf:
            - $ref: '#/components/schemas/TieredPricingModelInput'
          description: Tiered pricing model (required when type=tiered)
          nullable: true
        trial_period_days:
          description: Trial period in days (minimum 1)
          example: 30
          format: int64
          nullable: true
          type: integer
        type:
          description: Pricing type
          enum:
            - unit
            - fixed
            - tiered
            - graduated_tiered
            - tiered_percentage
            - graduated_percentage
            - volume_percentage
            - prepaid_tiered
            - prepaid_fixed_tiered
            - expression
          example: fixed
          type: string
        unit_pricing_model:
          allOf:
            - $ref: '#/components/schemas/UnitPricingModelInput'
          description: Unit pricing model (required when type=unit)
          nullable: true
        volume_percentage_pricing_model:
          allOf:
            - $ref: '#/components/schemas/VolumePercentagePricingModelInput'
          description: >-
            Volume percentage pricing model (required when
            type=volume_percentage)
          nullable: true
      required:
        - billing_direction
        - fee_type
        - type
      type: object
    ExpressionPricingModelInput:
      properties:
        charges:
          description: Expression-based charges
          items:
            $ref: '#/components/schemas/ExpressionChargeInput'
          type: array
        metric_bindings:
          description: Alias-to-metric bindings referenced in expressions
          items:
            $ref: '#/components/schemas/MetricBinding'
          type: array
      required:
        - charges
      type: object
    FixedPricingModelInput:
      properties:
        price_per_unit:
          description: Price per unit
          example: '500.00'
          type: string
        units:
          description: Number of units
          example: 1
          format: int64
          type: integer
      required:
        - price_per_unit
        - units
      type: object
    GraduatedPercentagePricingModelInput:
      properties:
        tiers:
          description: Percentage-based pricing tiers
          items:
            $ref: '#/components/schemas/PercentageTierInput'
          type: array
      required:
        - tiers
      type: object
    GraduatedTieredPricingModelInput:
      properties:
        tiers:
          description: Pricing tiers
          items:
            $ref: '#/components/schemas/PricingTierInput'
          type: array
        units:
          description: Fixed quantity of units (for fixed fee type only)
          example: 10
          format: int64
          nullable: true
          type: integer
      required:
        - tiers
      type: object
    PrepaidFixedTieredPricingModelInput:
      properties:
        overages_charge_interval:
          description: Overage charge interval
          enum:
            - monthly
            - quarterly
            - semi_annual
            - yearly
          example: monthly
          type: string
        prepaid_units:
          description: Number of prepaid units
          example: 50000
          format: int64
          type: integer
        tiers:
          description: Overage pricing tiers
          items:
            $ref: '#/components/schemas/PricingTierInput'
          type: array
      required:
        - overages_charge_interval
        - prepaid_units
        - tiers
      type: object
    PrepaidTieredPricingModelInput:
      properties:
        prepaid_units:
          description: Number of prepaid units
          example: 50000
          format: int64
          type: integer
        tiers:
          description: Overage pricing tiers
          items:
            $ref: '#/components/schemas/PricingTierInput'
          type: array
      required:
        - prepaid_units
        - tiers
      type: object
    TieredPercentagePricingModelInput:
      properties:
        tiers:
          description: Percentage-based pricing tiers
          items:
            $ref: '#/components/schemas/PercentageTierInput'
          type: array
      required:
        - tiers
      type: object
    TieredPricingModelInput:
      properties:
        tiers:
          description: Pricing tiers
          items:
            $ref: '#/components/schemas/PricingTierInput'
          type: array
        units:
          description: Fixed quantity of units (for fixed fee type only)
          example: 10
          format: int64
          nullable: true
          type: integer
      required:
        - tiers
      type: object
    UnitPricingModelInput:
      properties:
        price_per_unit:
          description: Price per unit
          example: '0.05'
          type: string
      required:
        - price_per_unit
      type: object
    VolumePercentagePricingModelInput:
      properties:
        fixed_fee:
          description: Optional fixed fee
          example: '5.00'
          nullable: true
          type: string
        percentage:
          description: Percentage rate
          example: '2.0'
          type: string
        price_per_unit:
          description: Base price per unit
          example: '0.05'
          type: string
      required:
        - percentage
        - price_per_unit
      type: object
    ExpressionChargeInput:
      properties:
        billing_direction:
          description: Billing direction
          enum:
            - advance
            - arrears
          example: arrears
          type: string
        description:
          description: Charge description
          example: API usage charge
          type: string
        quantity_expression:
          description: Expression for quantity
          example: usage.api_calls
          type: string
        unit_price_expression:
          description: Expression for unit price
          example: '0.01'
          type: string
      required:
        - billing_direction
        - description
        - quantity_expression
        - unit_price_expression
      type: object
    MetricBinding:
      properties:
        alias:
          description: Alias referenced in charge expressions
          example: api_calls
          type: string
        metric_id:
          description: Metric ID bound to the alias
          type: string
      required:
        - alias
        - metric_id
      type: object
    PercentageTierInput:
      properties:
        fixed_fee:
          description: Fixed fee
          example: '10.00'
          nullable: true
          type: string
        max_units:
          description: Upper bound (null = unlimited)
          example: 10000
          format: int64
          nullable: true
          type: integer
        min_units:
          description: Lower bound of the tier (inclusive)
          example: 0
          format: int64
          type: integer
        percentage:
          description: Percentage rate
          example: '2.5'
          nullable: true
          type: string
      required:
        - min_units
      type: object
    PricingTierInput:
      properties:
        fixed_fee:
          description: Fixed fee for this tier
          example: '10.00'
          nullable: true
          type: string
        max_units:
          description: Upper bound (null = unlimited)
          example: 10000
          format: int64
          nullable: true
          type: integer
        min_units:
          description: Lower bound of the tier (inclusive)
          example: 0
          format: int64
          type: integer
        price_per_unit:
          description: Price per unit
          example: '0.02'
          nullable: true
          type: string
      required:
        - min_units
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: API Key
      description: API key authentication. Pass your API key as a Bearer token.
      scheme: bearer
      type: http

````