Subscription

Initialize Subscription (iyzico Checkout Form)

Used to start a subscription with iyzico Checkout Form. Returns the form content and token.

post/v2/subscription/checkoutform/initialize

Request

Base URL
https://sandbox-api.iyzipay.com
Auth
none declared. Required headers: Authorization, Content-Type
TypeScript
https://skmtc.dev/iyzico/apis/bin-and-installment/docs/v2/subscription/checkoutform/initialize/post.ts
A function with typed inputs. Its response is checked against the schema.

Authorizationstring required

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-Typestring required

Content-Type değeri.

locale'tr' | 'en'

Language code. Default is tr. Send "en" to create the checkout form in English.

callbackUrlstring required

Callback URL to which the payment result will be sent.

pricingPlanReferenceCodestring required

Reference code of the plan to start the subscription.

subscriptionInitialStatus'ACTIVE' | 'PENDING' required

Initial status. If PENDING, subscription will not start until activated.

conversationIdstring

Optional correlation value to match request/response pairs.

Successful response

status'success' | 'failure'

Operation result.

locale'tr' | 'en'

Response language.

systemTimeinteger

Operation time (epoch ms).

conversationIdstring

Echoes the value you sent in the request.

tokenstring

Token of the checkout form.

checkoutFormContentstring

HTML content of the checkout form.

tokenExpireTimeinteger

Token validity time in seconds.

No recorded changes to this operation across all 1 revision of this API.