> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Plan

> Update a plan's pricing, billing interval, visibility, stock, and other settings.



## OpenAPI

````yaml /openapi/api-v1-native.yml patch /plans/{id}
openapi: 3.1.0
info:
  title: Whop API
  description: >-
    Hand-written V1 endpoints. Merged into the GraphqlRestProxy-generated schema
    at build time.
  version: v1
servers:
  - url: https://{defaultHost}
    variables:
      defaultHost:
        default: api.whop.com/api/v1
security: []
paths:
  /plans/{id}:
    parameters:
      - $ref: '#/components/parameters/ApiVersionDate'
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Plan ID, prefixed `plan_`.
    patch:
      tags:
        - Plans
      summary: Update Plan
      description: >-
        Update a plan's pricing, billing interval, visibility, stock, and other
        settings.
      operationId: updatePlan
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                offer_cancel_discount:
                  type:
                    - boolean
                    - 'null'
                  description: >-
                    Whether to offer a retention discount when a customer
                    attempts to cancel.
                strike_through_initial_price:
                  type:
                    - number
                    - 'null'
                  description: >-
                    A comparison price displayed with a strikethrough for the
                    initial price.
                strike_through_renewal_price:
                  type:
                    - number
                    - 'null'
                  description: >-
                    A comparison price displayed with a strikethrough for the
                    renewal price.
                adaptive_pricing_enabled:
                  type:
                    - boolean
                    - 'null'
                  description: >-
                    Whether this plan accepts local currency payments via
                    adaptive pricing.
                billing_period:
                  type:
                    - integer
                    - 'null'
                  description: >-
                    Recurring billing interval in days, such as 30 for monthly
                    or 365 for annual.
                checkout_styling:
                  type:
                    - object
                    - 'null'
                  description: Checkout styling overrides for this plan.
                currency:
                  type: string
                  description: >-
                    The three-letter ISO currency code for the plan's pricing.
                    Defaults to USD.
                custom_fields:
                  type:
                    - array
                    - 'null'
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        description: The ID of the custom field (if being updated).
                      field_type:
                        type: string
                        enum:
                          - text
                        description: The type of the custom field.
                      name:
                        type: string
                        description: The name of the custom field.
                      order:
                        type: integer
                        description: The order of the field.
                      placeholder:
                        type:
                          - string
                          - 'null'
                        description: An example response displayed in the input field.
                      required:
                        type: boolean
                        description: Whether or not the field is required.
                  description: >-
                    An array of custom field definitions to collect from
                    customers at checkout. Omitting this field clears existing
                    custom fields.
                description:
                  type:
                    - string
                    - 'null'
                  description: >-
                    A text description of the plan displayed to customers on the
                    product page.
                expiration_days:
                  type:
                    - integer
                    - 'null'
                  description: Access duration in days before the membership expires.
                image:
                  type:
                    - object
                    - 'null'
                  properties:
                    id:
                      type: string
                    direct_upload_id:
                      type: string
                  description: >-
                    An image displayed on the product page to represent this
                    plan.
                initial_price:
                  type:
                    - number
                    - 'null'
                  description: >-
                    Initial amount charged in the plan's currency, e.g. 10.43
                    for $10.43.
                internal_notes:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Private notes visible only to the account owner. Not shown
                    to customers.
                legacy_payment_method_controls:
                  type:
                    - boolean
                    - 'null'
                  description: Whether this plan uses legacy payment method controls.
                metadata:
                  type:
                    - object
                    - 'null'
                  description: >-
                    Custom key-value pairs to store on the plan. Included in
                    webhook payloads for payment and membership events. Max 50
                    keys, 100 chars per key, 500 chars per string value.
                override_tax_type:
                  type: string
                  description: >-
                    Override the default tax classification for this specific
                    plan.
                payment_method_configuration:
                  type:
                    - object
                    - 'null'
                  description: >-
                    Explicit payment method configuration for the plan. When not
                    provided, the account's defaults apply.
                  properties:
                    enabled:
                      type: array
                      items:
                        type: string
                    disabled:
                      type: array
                      items:
                        type: string
                    include_platform_defaults:
                      type: boolean
                renewal_price:
                  type:
                    - number
                    - 'null'
                  description: >-
                    The amount charged each billing period for recurring plans,
                    in the plan's currency.
                stock:
                  type:
                    - integer
                    - 'null'
                  description: >-
                    The maximum number of units available for purchase. Ignored
                    when unlimited_stock is true.
                three_ds_level:
                  type: string
                  enum:
                    - mandate_challenge
                    - frictionless
                  description: >-
                    3D Secure behavior for this plan. Send `null` to inherit the
                    account default.
                title:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The display name of the plan shown to customers on the
                    product page.
                trial_period_days:
                  type:
                    - integer
                    - 'null'
                  description: Free trial duration before the first recurring charge.
                unlimited_stock:
                  type:
                    - boolean
                    - 'null'
                  description: >-
                    Whether the plan has unlimited stock. When true, the stock
                    field is ignored.
                visibility:
                  type: string
                  description: >-
                    Whether the plan is visible to customers or hidden from
                    public view.
        required: true
      responses:
        '200':
          description: plan updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
        '401':
          $ref: '#/components/responses/Unauthorized'
          description: missing or invalid authentication
      security:
        - bearerAuth:
            - plan:update
components:
  parameters:
    ApiVersionDate:
      name: Api-Version-Date
      in: header
      required: false
      schema:
        type: string
        format: date
        example: '2026-06-20'
      description: >-
        Pins the request to a dated API version. When omitted, the request uses
        the original (2025-01-01) request/response shapes, so existing
        unversioned callers are never broken. Generated SDKs always send the
        latest version they were built against. An unrecognized value is
        rejected with a 400. The schemas documented here always describe the
        latest version.
  schemas:
    Plan:
      type: object
      properties:
        id:
          type: string
          description: Plan ID, prefixed `plan_`.
        created_at:
          type: string
          description: When the plan was created, as an ISO 8601 timestamp.
        updated_at:
          type: string
          description: When the plan was last updated, as an ISO 8601 timestamp.
        visibility:
          type: string
          description: Whether the plan is visible to customers or hidden from public view.
          enum:
            - visible
            - hidden
            - archived
            - quick_link
          example: visible
        plan_type:
          type: string
          description: >-
            Billing model for this plan: `renewal` (recurring) or `one_time`
            (single payment).
          enum:
            - renewal
            - one_time
          example: renewal
        release_method:
          type: string
          description: Sales method for this plan, such as `buy_now` or `waitlist`.
          enum:
            - buy_now
            - waitlist
          example: buy_now
        currency:
          type: string
          description: Three-letter ISO currency code for this plan's prices.
          enum:
            - usd
            - sgd
            - inr
            - aud
            - brl
            - cad
            - dkk
            - eur
            - nok
            - gbp
            - sek
            - chf
            - hkd
            - huf
            - jpy
            - mxn
            - myr
            - pln
            - czk
            - nzd
            - aed
            - eth
            - ape
            - cop
            - ron
            - thb
            - bgn
            - idr
            - dop
            - php
            - try
            - krw
            - twd
            - vnd
            - pkr
            - clp
            - uyu
            - ars
            - zar
            - dzd
            - tnd
            - mad
            - kes
            - kwd
            - jod
            - all
            - xcd
            - amd
            - bsd
            - bhd
            - bob
            - bam
            - khr
            - crc
            - xof
            - egp
            - etb
            - gmd
            - ghs
            - gtq
            - gyd
            - ils
            - jmd
            - mop
            - mga
            - mur
            - mdl
            - mnt
            - nad
            - ngn
            - mkd
            - omr
            - pyg
            - pen
            - qar
            - rwf
            - sar
            - rsd
            - lkr
            - tzs
            - ttd
            - uzs
            - rub
            - btc
            - cny
            - usdt
            - kzt
            - awg
            - whop_usd
            - xau
          example: usd
        account:
          type:
            - object
            - 'null'
          description: Account that sells this plan; `null` for standalone invoice plans.
        product:
          type:
            - object
            - 'null'
          description: Product this plan belongs to; `null` for standalone plans.
        invoice:
          type:
            - object
            - 'null'
          description: >-
            Invoice this plan was generated for; `null` unless created for an
            invoice.
        billing_period:
          type:
            - number
            - 'null'
          description: >-
            Recurring billing interval in days, such as 30 for monthly or 365
            for annual. `null` for one-time plans.
        title:
          type:
            - string
            - 'null'
          description: Plan display name shown to customers.
        description:
          type:
            - string
            - 'null'
          description: Customer-visible plan description.
        purchase_url:
          type: string
          description: URL where customers can purchase this plan directly.
        expiration_days:
          type:
            - number
            - 'null'
          description: Access duration in days for expiration-based plans.
        initial_price:
          type: number
          description: Initial purchase price in plan currency.
        renewal_price:
          type: number
          description: Recurring price charged every billing period.
        trial_period_days:
          type:
            - number
            - 'null'
          description: >-
            Free trial days before the first renewal charge. `null` if no trial
            is configured or the user has already used a trial for this plan.
        three_ds_level:
          type:
            - string
            - 'null'
          description: 3D Secure behavior for this plan; `null` inherits account default.
          enum:
            - mandate_challenge
            - frictionless
            - null
          example: mandate_challenge
        member_count:
          type:
            - number
            - 'null'
          description: Active memberships through this plan, when visible to the requester.
        internal_notes:
          type:
            - string
            - 'null'
          description: Private notes visible only to authorized team members.
        metadata:
          type:
            - object
            - 'null'
          description: Custom key-value pairs stored on the plan.
        stock:
          type:
            - number
            - 'null'
          description: Units available for purchase, when visible to the requester.
        unlimited_stock:
          type: boolean
          description: Whether the plan has unlimited stock.
        split_pay_required_payments:
          type:
            - number
            - 'null'
          description: Installment payments required before the subscription pauses.
        adaptive_pricing_enabled:
          type: boolean
          description: >-
            Whether this plan accepts local currency payments via adaptive
            pricing.
        payment_method_configuration:
          type:
            - object
            - 'null'
          description: >-
            Payment method configuration (`enabled`, `disabled`,
            `include_platform_defaults`); `null` when plan uses default
            settings.
        tax_type:
          type: string
          description: How tax is handled for this plan.
          enum:
            - inclusive
            - exclusive
            - unspecified
          example: inclusive
        collect_tax:
          type: boolean
          description: Whether tax is collected on purchases of this plan.
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/PlanCustomField'
            description: Custom input fields collected on the checkout form.
      required:
        - id
        - created_at
        - updated_at
        - visibility
        - plan_type
        - release_method
        - currency
        - account
        - product
        - invoice
        - billing_period
        - title
        - description
        - purchase_url
        - expiration_days
        - initial_price
        - renewal_price
        - trial_period_days
        - three_ds_level
        - member_count
        - internal_notes
        - metadata
        - stock
        - unlimited_stock
        - split_pay_required_payments
        - adaptive_pricing_enabled
        - payment_method_configuration
        - tax_type
        - collect_tax
        - custom_fields
    PlanCustomField:
      type: object
      properties:
        id:
          type: string
          description: Custom field ID.
        field_type:
          type: string
          description: Custom field input type.
          enum:
            - text
          example: text
        name:
          type: string
          description: Field label shown to customer at checkout.
        order:
          type: number
          description: Field position on checkout form.
        placeholder:
          type:
            - string
            - 'null'
          description: Placeholder text shown in empty field.
        required:
          type: boolean
          description: Whether the customer must complete this field to check out.
      required:
        - id
        - field_type
        - name
        - order
        - placeholder
        - required
    V1ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - type
            - message
      required:
        - error
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V1ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: auth-scheme
      description: >-
        An account API key, account scoped JWT, app API key, or user OAuth
        token.

````