---
title: "Create subscription"
method: POST
path: "/api/v1/subscriptions"
tags: ["subscription"]
---

# Create subscription

`POST /api/v1/subscriptions`

Create a new subscription for a customer with a specific plan.

## Request body

- SubscriptionCreateRequest
  - `activation_condition` 'ON_START' | 'ON_CHECKOUT' | 'MANUAL', required
  - `add_ons` CreateSubscriptionAddOn[]
    - `add_on_id` string, MeteroidId, required
    - `customization` union
      - object
        - `fee` union, required
          - object
            - `discriminator` 'RATE', required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'ONE_TIME', required
            - `quantity` integer, required
            - `rate` string, decimal, required
          - object
            - `billing_type` 'ADVANCE' | 'ARREARS', required
            - `discriminator` 'RECURRING', required
            - `quantity` integer, required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'CAPACITY', required
            - `included` integer, required
            - `metric_id` string, MeteroidId, required
            - `overage_rate` string, decimal, required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'SLOT', required
            - `initial_slots` integer, required
            - `max_slots` integer, nullable
            - `min_slots` integer, nullable
            - `unit` string, required
            - `unit_rate` string, decimal, required
          - object
            - `discriminator` 'USAGE', required
            - `metric_id` string, MeteroidId, required
            - `model` union, required
              - …
        - `name` string, required
        - `period` 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
        - `discriminator` 'OVERRIDE', required
      - object
        - `billing_period` 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL'
        - `committed_capacity` integer, nullable
        - `initial_slot_count` integer, nullable
        - `discriminator` 'PARAMETERIZATION', required
  - `auto_advance_invoices` boolean
  - `billing_day_anchor` integer, nullable
  - `charge_automatically` boolean
  - `coupon_codes` string[]
  - `customer_id_or_alias` string, CustomerId or customer alias, required
  - `end_date` string, date
  - `invoice_memo` string
  - `net_terms` integer
  - `plan_id` string, MeteroidId, required
  - `price_components` CreateSubscriptionComponents
    - `extra_components` ExtraComponent[], nullable
      - `component` SubscriptionComponent, required
        - `fee` union, required
          - object
            - `discriminator` 'RATE', required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'ONE_TIME', required
            - `quantity` integer, required
            - `rate` string, decimal, required
          - object
            - `billing_type` 'ADVANCE' | 'ARREARS', required
            - `discriminator` 'RECURRING', required
            - `quantity` integer, required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'CAPACITY', required
            - `included` integer, required
            - `metric_id` string, MeteroidId, required
            - `overage_rate` string, decimal, required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'SLOT', required
            - `initial_slots` integer, required
            - `max_slots` integer, nullable
            - `min_slots` integer, nullable
            - `unit` string, required
            - `unit_rate` string, decimal, required
          - object
            - `discriminator` 'USAGE', required
            - `metric_id` string, MeteroidId, required
            - `model` union, required
              - …
        - `name` string, required
        - `period` 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
        - `price_component_id` string, MeteroidId
        - `product_id` string, MeteroidId
    - `overridden_components` ComponentOverride[], nullable
      - `component` SubscriptionComponent, required
        - `fee` union, required
          - object
            - `discriminator` 'RATE', required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'ONE_TIME', required
            - `quantity` integer, required
            - `rate` string, decimal, required
          - object
            - `billing_type` 'ADVANCE' | 'ARREARS', required
            - `discriminator` 'RECURRING', required
            - `quantity` integer, required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'CAPACITY', required
            - `included` integer, required
            - `metric_id` string, MeteroidId, required
            - `overage_rate` string, decimal, required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'SLOT', required
            - `initial_slots` integer, required
            - `max_slots` integer, nullable
            - `min_slots` integer, nullable
            - `unit` string, required
            - `unit_rate` string, decimal, required
          - object
            - `discriminator` 'USAGE', required
            - `metric_id` string, MeteroidId, required
            - `model` union, required
              - …
        - `name` string, required
        - `period` 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
        - `price_component_id` string, MeteroidId
        - `product_id` string, MeteroidId
      - `component_id` string, MeteroidId, required
    - `parameterized_components` ComponentParameterization[], nullable
      - `component_id` string, MeteroidId, required
      - `parameters` ComponentParameters, required
        - `billing_period` 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL'
        - `committed_capacity` integer, nullable
        - `initial_slot_count` integer, nullable
    - `remove_components` PriceComponentId[], nullable
  - `purchase_order` string, nullable
  - `start_date` string, date, required
  - `trial_days` integer
  - `version` integer

## Response `201`

Subscription successfully created

- SubscriptionDetails
  - `add_ons` SubscriptionAddOn[], required
    - `add_on_id` string, MeteroidId
    - `fee` union, required
      - object
        - `discriminator` 'RATE', required
        - `rate` string, decimal, required
      - object
        - `discriminator` 'ONE_TIME', required
        - `quantity` integer, required
        - `rate` string, decimal, required
      - object
        - `billing_type` 'ADVANCE' | 'ARREARS', required
        - `discriminator` 'RECURRING', required
        - `quantity` integer, required
        - `rate` string, decimal, required
      - object
        - `discriminator` 'CAPACITY', required
        - `included` integer, required
        - `metric_id` string, MeteroidId, required
        - `overage_rate` string, decimal, required
        - `rate` string, decimal, required
      - object
        - `discriminator` 'SLOT', required
        - `initial_slots` integer, required
        - `max_slots` integer, nullable
        - `min_slots` integer, nullable
        - `unit` string, required
        - `unit_rate` string, decimal, required
      - object
        - `discriminator` 'USAGE', required
        - `metric_id` string, MeteroidId, required
        - `model` union, required
          - object
            - `discriminator` 'PER_UNIT', required
            - `rate` string, decimal, required
          - object
            - `block_size` integer, nullable
            - `discriminator` 'TIERED', required
            - `tiers` TierRow[], required
              - …
          - object
            - `block_size` integer, nullable
            - `discriminator` 'VOLUME', required
            - `tiers` TierRow[], required
              - …
          - object
            - `block_size` integer, required
            - `discriminator` 'PACKAGE', required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'MATRIX', required
            - `rates` MatrixRow[], required
              - …
    - `name` string, required
    - `period` 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
  - `applied_coupons` AppliedCouponDetailed[], required
    - `applied_coupon` AppliedCoupon, required
      - `applied_amount` string, decimal, nullable
      - `applied_count` integer, nullable
      - `coupon_id` string, MeteroidId, required
      - `created_at` string, date-time, required
      - `id` string, MeteroidId, required
      - `is_active` boolean, required
      - `last_applied_at` string, date-time, nullable
    - `coupon` Coupon, required
      - `code` string, required
      - `description` string, required
      - `disabled` boolean, required
      - `discount` union, required
        - object
          - `discriminator` 'PERCENTAGE', required
          - `percentage` string, decimal, required
        - object
          - `amount` string, decimal, required
          - `currency` string, required
          - `discriminator` 'FIXED', required
      - `expires_at` string, date-time, nullable
      - `id` string, MeteroidId, required
      - `recurring_value` integer, nullable
      - `redemption_limit` integer, nullable
      - `reusable` boolean, required
  - `auto_advance_invoices` boolean, required
  - `billing_day_anchor` integer, required
  - `charge_automatically` boolean, required
  - `checkout_url` string, nullable
  - `components` SubscriptionComponent[], required
    - `fee` union, required
      - object
        - `discriminator` 'RATE', required
        - `rate` string, decimal, required
      - object
        - `discriminator` 'ONE_TIME', required
        - `quantity` integer, required
        - `rate` string, decimal, required
      - object
        - `billing_type` 'ADVANCE' | 'ARREARS', required
        - `discriminator` 'RECURRING', required
        - `quantity` integer, required
        - `rate` string, decimal, required
      - object
        - `discriminator` 'CAPACITY', required
        - `included` integer, required
        - `metric_id` string, MeteroidId, required
        - `overage_rate` string, decimal, required
        - `rate` string, decimal, required
      - object
        - `discriminator` 'SLOT', required
        - `initial_slots` integer, required
        - `max_slots` integer, nullable
        - `min_slots` integer, nullable
        - `unit` string, required
        - `unit_rate` string, decimal, required
      - object
        - `discriminator` 'USAGE', required
        - `metric_id` string, MeteroidId, required
        - `model` union, required
          - object
            - `discriminator` 'PER_UNIT', required
            - `rate` string, decimal, required
          - object
            - `block_size` integer, nullable
            - `discriminator` 'TIERED', required
            - `tiers` TierRow[], required
              - …
          - object
            - `block_size` integer, nullable
            - `discriminator` 'VOLUME', required
            - `tiers` TierRow[], required
              - …
          - object
            - `block_size` integer, required
            - `discriminator` 'PACKAGE', required
            - `rate` string, decimal, required
          - object
            - `discriminator` 'MATRIX', required
            - `rates` MatrixRow[], required
              - …
    - `name` string, required
    - `period` 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'ANNUAL', required
    - `price_component_id` string, MeteroidId
    - `product_id` string, MeteroidId
  - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNH' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL', required
  - `current_period_end` string, date, nullable
  - `current_period_start` string, date, required
  - `customer_alias` string, nullable
  - `customer_id` string, MeteroidId, required
  - `customer_name` string, required
  - `id` string, MeteroidId, required
  - `plan_id` string, MeteroidId, required
  - `plan_name` string, required
  - `plan_version` integer, required
  - `plan_version_id` string, MeteroidId, required
  - `purchase_order` string, nullable
  - `status` 'PENDING_ACTIVATION' | 'PENDING_CHARGE' | 'TRIAL_ACTIVE' | 'ACTIVE' | 'TRIAL_EXPIRED' | 'PAUSED' | 'SUSPENDED' | 'CANCELLED' | 'COMPLETED' | 'SUPERSEDED', required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Internal error

## Changes

- **2025-10-17** (v1) `b03a38c9dbd4` — 1 breaking, 2 warning, 4 info
  - removed `subschema #1, subschema #2` from the `add_ons/items/customization/oneOf[#/components/schemas/SubscriptionAddOnCustomization]/` request property `oneOf` list
  - added the new `SEMIANNUAL` enum value to the `add_ons/items/period` response property for the response status `201`
  - added the new `SEMIANNUAL` enum value to the `components/items/period` response property for the response status `201`
  - added the new `SEMIANNUAL` enum value to the request property `price_components/extra_components/items/component/period`
  - …3 more
- **2025-10-16** (v1) `a174f46ee4f8` — 4 info
  - added the new optional request property `auto_advance_invoices`
  - added the new optional request property `charge_automatically`
  - added the required property `auto_advance_invoices` to the response with the `201` status
  - added the required property `charge_automatically` to the response with the `201` status
- **2025-10-14** (v1) `532c5edf3ddd` — 9 breaking, 2 warning, 9 info
  - added the new required request property `plan_id`
  - the request property `add_ons` became not nullable
  - the request property `coupon_codes` became not nullable
  - the request property `end_date` became not nullable
  - …16 more
- **2025-10-14** (v1) `da72c03d9734` — 2 info
  - added the new optional request property `purchase_order`
  - added the optional property `purchase_order` to the response with the `201` status
- …earlier changes not shown

[Full history](https://skmtc.dev/meteroid-oss/apis/meteroid/changes/api/v1/subscriptions/post.md)

---

[API](https://skmtc.dev/meteroid-oss/apis/meteroid.md) · [All operations](https://skmtc.dev/meteroid-oss/apis/meteroid/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/meteroid-oss/meteroid/revisions/b03a38c9dbd4/schema)