> For the complete documentation index, see [llms.txt](https://docs.iyzico.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iyzico.com/en/getting-started/preliminaries/api-reference-beta/subscription/pricing-plan.md).

# Pricing Plan

## Create Pricing Plan

> Creates a new pricing plan for a specific product.

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/products/{productReferenceCode}/pricing-plans":{"post":{"summary":"Create Pricing Plan","description":"Creates a new pricing plan for a specific product.","tags":["Pricing Plan"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"productReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Reference code of the product the plan will be attached to."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePricingPlanRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePricingPlanResponse"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"Format of the request payload."}},"schemas":{"CreatePricingPlanRequest":{"type":"object","required":["name","price","currencyCode","paymentInterval","planPaymentType"],"properties":{"name":{"type":"string","description":"Pricing plan name."},"price":{"type":"decimal","description":"Amount to charge on each billing period."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Currency. (For foreign currency, only non-TRY cards are allowed.)"},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Recurrence interval for the subscription charge."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Subscription type."},"paymentIntervalCount":{"type":"integer","description":"Frequency multiplier for the interval. For example, if you set a weekly plan and send **2**, the charge occurs every 2 weeks."},"recurrenceCount":{"type":"integer","description":"Total number of repeats (e.g., **12** → 12 months). If omitted, it continues until the subscription is canceled."},"trialPeriodDays":{"type":"integer","description":"Free trial length in days. If provided, the first charge happens after this period."},"locale":{"type":"string","enum":["tr","en"],"description":"Language of the response and error messages."},"conversationId":{"type":"string","description":"Custom identifier for request tracking."}}},"CreatePricingPlanResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"],"description":"Result of the operation."},"systemTime":{"type":"integer","description":"Operation time (epoch ms)."},"data":{"type":"object","properties":{"referenceCode":{"type":"string","description":"Reference code of the created plan."},"createdDate":{"type":"integer","description":"Plan creation time (epoch ms)."},"name":{"type":"string","description":"Plan name."},"productReferenceCode":{"type":"string","description":"Product reference code."},"price":{"type":"decimal","description":"Subscription price."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Currency code."},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Billing interval."},"paymentIntervalCount":{"type":"integer","description":"Interval multiplier."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Subscription type."},"recurrenceCount":{"type":"integer","description":"Number of repeats."},"trialPeriodDays":{"type":"integer","description":"Trial period (days)."},"status":{"type":"string","enum":["ACTIVE"],"description":"Plan status."}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```

## Update Pricing Plan

> This method allows updating \*\*only\*\* the \*\*name\*\* and \*\*trialPeriodDays\*\* fields.   The plan's reference code must be provided as a path parameter.   Updates can be performed via API or the iyzico merchant panel. Active subscriptions are not affected.<br>

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/pricing-plans/{pricingPlanReferenceCode}":{"post":{"summary":"Update Pricing Plan","description":"This method allows updating **only** the **name** and **trialPeriodDays** fields.   The plan's reference code must be provided as a path parameter.   Updates can be performed via API or the iyzico merchant panel. Active subscriptions are not affected.\n","tags":["Pricing Plan"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"pricingPlanReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Reference code of the pricing plan to be updated."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePricingPlanRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePricingPlanResponse"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"Format of the request payload."}},"schemas":{"UpdatePricingPlanRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Updated plan name."},"trialPeriodDays":{"type":"integer","description":"Updated trial period (days)."}}},"UpdatePricingPlanResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"],"description":"Result of the operation."},"systemTime":{"type":"integer","description":"Operation time (epoch ms)."},"data":{"type":"object","properties":{"referenceCode":{"type":"string","description":"Reference code of the updated plan."},"createdDate":{"type":"integer","description":"Plan creation time (epoch ms)."},"name":{"type":"string","description":"Updated plan name."},"price":{"type":"decimal","description":"Plan price."},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Billing interval."},"paymentIntervalCount":{"type":"integer","description":"Interval multiplier."},"trialPeriodDays":{"type":"integer","description":"Updated trial period (days)."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Currency code."},"productReferenceCode":{"type":"string","description":"Product reference code."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Subscription type."},"status":{"type":"string","enum":["ACTIVE"],"description":"Plan status."},"recurrenceCount":{"type":"integer","description":"Number of repeats."}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```

## Delete Pricing Plan

> Deletes the specified pricing plan by reference code. Plans with active subscriptions or pending updates cannot be deleted.

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/pricing-plans/{pricingPlanReferenceCode}":{"delete":{"summary":"Delete Pricing Plan","description":"Deletes the specified pricing plan by reference code. Plans with active subscriptions or pending updates cannot be deleted.","tags":["Pricing Plan"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"pricingPlanReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Reference code of the pricing plan to delete."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePricingPlanResponse"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"Format of the request payload."}},"schemas":{"DeletePricingPlanResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"]},"systemTime":{"type":"integer"}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```

## List Pricing Plans

> Lists all pricing plans for a given product. The response is paginated.

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/products/{productReferenceCode}/pricing-plans":{"get":{"summary":"List Pricing Plans","description":"Lists all pricing plans for a given product. The response is paginated.","tags":["Pricing Plan"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"productReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Product reference code."},{"name":"page","in":"query","schema":{"type":"integer"},"description":"Page number to list."},{"name":"count","in":"query","schema":{"type":"integer"},"description":"Number of records per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPricingPlanResponse"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"Format of the request payload."}},"schemas":{"ListPricingPlanResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"]},"systemTime":{"type":"integer"},"data":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total record count."},"currentPage":{"type":"integer"},"pageCount":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/CreatePricingPlanResponse/properties/data"}}}}}},"CreatePricingPlanResponse":{"properties":{"data":{"type":"object","properties":{"referenceCode":{"type":"string","description":"Reference code of the created plan."},"createdDate":{"type":"integer","description":"Plan creation time (epoch ms)."},"name":{"type":"string","description":"Plan name."},"productReferenceCode":{"type":"string","description":"Product reference code."},"price":{"type":"decimal","description":"Subscription price."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Currency code."},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Billing interval."},"paymentIntervalCount":{"type":"integer","description":"Interval multiplier."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Subscription type."},"recurrenceCount":{"type":"integer","description":"Number of repeats."},"trialPeriodDays":{"type":"integer","description":"Trial period (days)."},"status":{"type":"string","enum":["ACTIVE"],"description":"Plan status."}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```

## Get Pricing Plan Detail

> Returns details of a pricing plan. Merchants can see all details both in the merchant panel and via API.

```json
{"openapi":"3.0.3","info":{"title":"Subscription Pricing Plan","version":"1.0.0"},"servers":[{"url":"https://api.iyzipay.com","description":"iyzico API"}],"paths":{"/v2/subscription/pricing-plans/{pricingPlanReferenceCode}":{"get":{"summary":"Get Pricing Plan Detail","description":"Returns details of a pricing plan. Merchants can see all details both in the merchant panel and via API.","tags":["Pricing Plan"],"parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"name":"pricingPlanReferenceCode","in":"path","required":true,"schema":{"type":"string"},"description":"Pricing plan reference code."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingPlanDetailResponse"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir."},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"Format of the request payload."}},"schemas":{"PricingPlanDetailResponse":{"type":"object","properties":{"status":{"type":"string","enum":["success","failure"]},"systemTime":{"type":"integer"},"data":{"$ref":"#/components/schemas/CreatePricingPlanResponse/properties/data"}}},"CreatePricingPlanResponse":{"properties":{"data":{"type":"object","properties":{"referenceCode":{"type":"string","description":"Reference code of the created plan."},"createdDate":{"type":"integer","description":"Plan creation time (epoch ms)."},"name":{"type":"string","description":"Plan name."},"productReferenceCode":{"type":"string","description":"Product reference code."},"price":{"type":"decimal","description":"Subscription price."},"currencyCode":{"type":"string","enum":["TRY","USD","EUR"],"description":"Currency code."},"paymentInterval":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","YEARLY"],"description":"Billing interval."},"paymentIntervalCount":{"type":"integer","description":"Interval multiplier."},"planPaymentType":{"type":"string","enum":["RECURRING"],"description":"Subscription type."},"recurrenceCount":{"type":"integer","description":"Number of repeats."},"trialPeriodDays":{"type":"integer","description":"Trial period (days)."},"status":{"type":"string","enum":["ACTIVE"],"description":"Plan status."}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["failure"]},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"systemTime":{"type":"integer"}}}}}}
```
