--- title: "Create plan" method: POST path: "/api/v1.4/subscriptions/plans/" tags: ["v1.1"] --- # Create plan `POST /api/v1.4/subscriptions/plans/` Create plan ## Request body - CreatePlan - `name` string, required — Plan name. - `description` string, required — Plan description. - `currency` 'usd' | 'cad' | 'eur' | 'aed' | 'afn' | 'all' | 'amd' | 'ars' | 'aud' | 'azn' | 'bam' | 'bdt' | 'bgn' | 'bhd' | 'bif' | 'bnd' | 'bob' | 'brl' | 'bwp' | 'byn' | 'bzd' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'eek' | 'egp' | 'ern' | 'etb' | 'gbp' | 'gel' | 'ghs' | 'gnf' | 'gtq' | 'hkd' | 'hnl' | 'hrk' | 'huf' | 'idr' | 'ils' | 'inr' | 'iqd' | 'irr' | 'isk' | 'jmd' | 'jod' | 'jpy' | 'kes' | 'khr' | 'kmf' | 'krw' | 'kwd' | 'kzt' | 'lbp' | 'lkr' | 'ltl' | 'lvl' | 'lyd' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mop' | 'mur' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'omr' | 'pab' | 'pen' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sdg' | 'sek' | 'sgd' | 'sos' | 'syp' | 'thb' | 'tnd' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'uyu' | 'uzs' | 'vef' | 'vnd' | 'xaf' | 'xof' | 'yer' | 'zar' | 'zmk' | 'zwl' | 'mru' | 'USD' | 'CAD' | 'EUR' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EEK' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMK' | 'ZWL' | 'MRU', required — The currency of the plan represented by a string of alphabetic code from ISO 4217 Currency codes * `usd` - usd * `cad` - cad * `eur` - eur * `aed` - aed * `afn` - afn * `all` - all * `amd` - amd * `ars` - ars * `aud` - aud * `azn` - azn * `bam` - bam * `bdt` - bdt * `bgn` - bgn * `bhd` - bhd * `bif` - bif * `bnd` - bnd * `bob` - bob * `brl` - brl * `bwp` - bwp * `byn` - byn * `bzd` - bzd * `cdf` - cdf * `chf` - chf * `clp` - clp * `cny` - cny * `cop` - cop * `crc` - crc * `cve` - cve * `czk` - czk * `djf` - djf * `dkk` - dkk * `dop` - dop * `dzd` - dzd * `eek` - eek * `egp` - egp * `ern` - ern * `etb` - etb * `gbp` - gbp * `gel` - gel * `ghs` - ghs * `gnf` - gnf * `gtq` - gtq * `hkd` - hkd * `hnl` - hnl * `hrk` - hrk * `huf` - huf * `idr` - idr * `ils` - ils * `inr` - inr * `iqd` - iqd * `irr` - irr * `isk` - isk * `jmd` - jmd * `jod` - jod * `jpy` - jpy * `kes` - kes * `khr` - khr * `kmf` - kmf * `krw` - krw * `kwd` - kwd * `kzt` - kzt * `lbp` - lbp * `lkr` - lkr * `ltl` - ltl * `lvl` - lvl * `lyd` - lyd * `mad` - mad * `mdl` - mdl * `mga` - mga * `mkd` - mkd * `mmk` - mmk * `mop` - mop * `mur` - mur * `mxn` - mxn * `myr` - myr * `mzn` - mzn * `nad` - nad * `ngn` - ngn * `nio` - nio * `nok` - nok * `npr` - npr * `nzd` - nzd * `omr` - omr * `pab` - pab * `pen` - pen * `php` - php * `pkr` - pkr * `pln` - pln * `pyg` - pyg * `qar` - qar * `ron` - ron * `rsd` - rsd * `rub` - rub * `rwf` - rwf * `sar` - sar * `sdg` - sdg * `sek` - sek * `sgd` - sgd * `sos` - sos * `syp` - syp * `thb` - thb * `tnd` - tnd * `top` - top * `try` - try * `ttd` - ttd * `twd` - twd * `tzs` - tzs * `uah` - uah * `ugx` - ugx * `uyu` - uyu * `uzs` - uzs * `vef` - vef * `vnd` - vnd * `xaf` - xaf * `xof` - xof * `yer` - yer * `zar` - zar * `zmk` - zmk * `zwl` - zwl * `mru` - mru * `USD` - USD * `CAD` - CAD * `EUR` - EUR * `AED` - AED * `AFN` - AFN * `ALL` - ALL * `AMD` - AMD * `ARS` - ARS * `AUD` - AUD * `AZN` - AZN * `BAM` - BAM * `BDT` - BDT * `BGN` - BGN * `BHD` - BHD * `BIF` - BIF * `BND` - BND * `BOB` - BOB * `BRL` - BRL * `BWP` - BWP * `BYN` - BYN * `BZD` - BZD * `CDF` - CDF * `CHF` - CHF * `CLP` - CLP * `CNY` - CNY * `COP` - COP * `CRC` - CRC * `CVE` - CVE * `CZK` - CZK * `DJF` - DJF * `DKK` - DKK * `DOP` - DOP * `DZD` - DZD * `EEK` - EEK * `EGP` - EGP * `ERN` - ERN * `ETB` - ETB * `GBP` - GBP * `GEL` - GEL * `GHS` - GHS * `GNF` - GNF * `GTQ` - GTQ * `HKD` - HKD * `HNL` - HNL * `HRK` - HRK * `HUF` - HUF * `IDR` - IDR * `ILS` - ILS * `INR` - INR * `IQD` - IQD * `IRR` - IRR * `ISK` - ISK * `JMD` - JMD * `JOD` - JOD * `JPY` - JPY * `KES` - KES * `KHR` - KHR * `KMF` - KMF * `KRW` - KRW * `KWD` - KWD * `KZT` - KZT * `LBP` - LBP * `LKR` - LKR * `LTL` - LTL * `LVL` - LVL * `LYD` - LYD * `MAD` - MAD * `MDL` - MDL * `MGA` - MGA * `MKD` - MKD * `MMK` - MMK * `MOP` - MOP * `MUR` - MUR * `MXN` - MXN * `MYR` - MYR * `MZN` - MZN * `NAD` - NAD * `NGN` - NGN * `NIO` - NIO * `NOK` - NOK * `NPR` - NPR * `NZD` - NZD * `OMR` - OMR * `PAB` - PAB * `PEN` - PEN * `PHP` - PHP * `PKR` - PKR * `PLN` - PLN * `PYG` - PYG * `QAR` - QAR * `RON` - RON * `RSD` - RSD * `RUB` - RUB * `RWF` - RWF * `SAR` - SAR * `SDG` - SDG * `SEK` - SEK * `SGD` - SGD * `SOS` - SOS * `SYP` - SYP * `THB` - THB * `TND` - TND * `TOP` - TOP * `TRY` - TRY * `TTD` - TTD * `TWD` - TWD * `TZS` - TZS * `UAH` - UAH * `UGX` - UGX * `UYU` - UYU * `UZS` - UZS * `VEF` - VEF * `VND` - VND * `XAF` - XAF * `XOF` - XOF * `YER` - YER * `ZAR` - ZAR * `ZMK` - ZMK * `ZWL` - ZWL * `MRU` - MRU - `amount` string, decimal, required — Plan's base amount to be used in subscription invoices. - `one_time_fee` string, decimal — One-time fee will be added once to the first subscription invoice when subscribing to this plan. - `trial_period` integer — Number of trial days before the first recurring cycle. - `recurrency` integer, required — The interval at which subscription is charged. Subscribers will pay every 'Recurrency x Recurrency_unit'. - `recurrency_unit` 'DAY' | 'MONTH', required — The time unit used to define the recurrency. DAY and MONTH are supported. * `DAY` - DAY * `MONTH` - MONTH - `recurring_cycles` integer — The total number of payment cycles in the subscription lifetime. if empty the subscription will be charged forever till canceled. - `discount_amount` string, decimal — Discount amount applied. Discount amount and percentage cannot be set together. - `discount_percentage` string, decimal — Discount percentage applied. Discount amount and percentage cannot be set together. - `discount_cycles` integer — How many cycles the discount will be applied to. ## Response `200` - PlanVersionDetails - `id` string, required - `name` string, required — Plan name. - `description` string, required — Plan description. - `currency` string, required — The currency of the plan represented by a string of alphabetic code from ISO 4217 Currency codes. - `amount` number, double, required — Plan's base amount to be used in subscription invoices. - `one_time_fee` string, required — One time fee will be added once to the first subscription invoice when subscripting to this plan. - `trial_period` integer, nullable, required — Number of trial days before the first recurring cycle. - `recurrency` integer, required — The interval at which a subscription is charged. - `recurrency_unit` string, required — The time unit used to define the recurrency. DAY and MONTH are supported - `recurring_cycles` integer, nullable, required — The total number of payment cycles in the subscription lifetime. if empty the subscription will be charged forever till canceled. - `discount_amount` string, required — Discount amount applied. - `discount_percentage` string, decimal, nullable, required — Discount percentage applied. - `discount_cycles` integer, nullable, required — How many cycles the discount will be applied to. - `is_live` boolean, required - `created` string, required ## Other responses - `400` - `401` --- [API](https://skmtc.net/moneyhash/apis/moneyhash-api.md) · [All operations](https://skmtc.net/moneyhash/apis/moneyhash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhash/moneyhash-api/versions/111e4c2e0826/schema)