v1

latestOpenAPI 3.0.32026-07-173038118.9 KB
Product Payment Plans

Update a product payment plan

patch/api/products/{productId}/payment-plans/{planId}

Path parameters

productIdstring required
planIdstring required

Request body

namestring

Payment plan name shown to customers.

type'free' | 'onetime' | 'emi' | 'subscription'
oneTimeAmountnumber

Required when type is onetime.

emiAmountnumber

Required when type is emi.

emiTotalInstallmentsnumber

Required when type is emi.

subscriptionMonthlyAmountnumber

Use for monthly subscriptions. For subscription, provide exactly one subscription amount.

subscriptionYearlyAmountnumber

Use for yearly subscriptions. For subscription, provide exactly one subscription amount.

descriptionstring

Response

Success.

planIdstring
namestring
type'free' | 'onetime' | 'emi' | 'subscription'
entityIdstring
entityTypestring
oneTimeAmountnumber
emiAmountnumber
emiTotalInstallmentsnumber
subscriptionMonthlyAmountnumber
subscriptionYearlyAmountnumber
descriptionstring
isDefaultboolean