Subscription Plans

Update a subscription plan

put/subscription/plans/{plan_id}

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/subscription/plans/{plan_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

plan_idinteger required

Request body

namestring nullable

Plan name

display_namestring nullable

Plan display name

descriptionstring nullable

Plan description

monthly_pricenumber nullable

Monthly price in USD

annual_pricenumber nullable

Annual price in USD

annual_onlyboolean nullable

Whether plan is annual only

is_self_serveboolean nullable

Whether users can self-subscribe

trial_daysinteger nullable

Trial period in days

storage_amountinteger nullable

Included storage in GB

max_storageinteger nullable

Maximum storage in GB

max_usersinteger nullable

Maximum number of users

no_of_usersinteger nullable

Number of included users

seat_pricenumber nullable

Price per additional user seat

number_of_tiersinteger nullable

Number of storage tiers

storage_block_sizeinteger nullable

Storage block size in GB

uses_inline_pricingboolean nullable

Bill this plan with composed price_data (plan price plus the chosen storage option) instead of stored Stripe prices

connector_profile_idinteger nullable

Connector profile ID

feature_profile_idinteger nullable

Feature profile ID

is_purchasableboolean nullable

Whether a new customer may pick this plan

lifecycle'current' | 'legacy' | 'system' | 'null' nullable

Catalog population: current, legacy or system

Response

Request fulfilled, document follows

messagestring nullable

Changes

No recorded changes to this operation across all 3 revisions of this API.