Update a pricing plan

🚧 Beta: This endpoint may not be available yet and may change without notice.
Contact support to request access.

Update a pricing plan. Content, visibility, access-limit, and enrollment-cap fields are applied. Read-only fields (for example price, currency) are rejected by request schema validation with 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Product type (courses, product-collections, digital-downloads, coaching, membership-tiers)

integer
required

Product ID

integer
required

Pricing plan ID

Body Params

Updates content, access-limit, and enrollment-cap fields on an existing pricing plan. The following fields are read-only after creation: currency, price, is_recurring, billing_interval, billing_interval_count, free_trial_length, num_payments_required, position.

string | null
string | null
string | null
string | null

Text shown on customer card statements. On schools using the new payments experience this is stored but not yet applied to statements.

boolean
date-time | null
string | null
integer | null
integer | null

Requires the school feature plan_supports_enrollment_cap. Returns 422 when enrollment_cap or enrollment_cap_expires_at is present and the feature is disabled.

date-time | null

Requires the school feature plan_supports_enrollment_cap. Returns 422 when enrollment_cap or enrollment_cap_expires_at is present and the feature is disabled.

string | null
integer | null
boolean | null
Headers
string
required

Generated Admin API key

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json