Update a product payment plan

Authorization

ApiKeyAuth

x-api-key<token>

API key created in CourseLit dashboard settings. The legacy apikey request-body field is still accepted but deprecated.

In: header

Path Parameters

productId*string

planId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Payment plan name shown to customers.

type?string

Value in"free" | "onetime" | "emi" | "subscription"

oneTimeAmount?number

Required when type is onetime.

emiAmount?number

Required when type is emi.

emiTotalInstallments?number

Required when type is emi.

subscriptionMonthlyAmount?number

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

subscriptionYearlyAmount?number

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

description?string

Response Body

`application/json`

curl -X PATCH "https://school.courselit.app/api/products/string/payment-plans/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Updated lifetime access",    "oneTimeAmount": 12900,    "description": "Updated one-time payment plan."  }'

{
  "planId": "string",
  "name": "string",
  "type": "free",
  "entityId": "string",
  "entityType": "string",
  "oneTimeAmount": 0,
  "emiAmount": 0,
  "emiTotalInstallments": 0,
  "subscriptionMonthlyAmount": 0,
  "subscriptionYearlyAmount": 0,
  "description": "string",
  "isDefault": true
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Update a product payment plan

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

422application/json

`application/json`

`application/json`

`application/json`