Subscription Plans

Create a new subscription plan

post/subscription/plans

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/subscription/plans
  • 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

Request body

namestring required

Plan name

display_namestring nullable

Plan display name

monthly_pricenumber required

Monthly price in USD

descriptionstring nullable

Plan description

annual_pricenumber nullable

Annual price in USD

annual_onlyboolean

Whether plan is annual only

is_self_serveboolean required

Whether users can self-subscribe

trial_daysinteger nullable

Trial period in days

storage_amountinteger

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

Number of storage tiers

storage_block_sizeinteger nullable

Storage block size in GB

uses_inline_pricingboolean

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

source_plan_idinteger nullable

Copy entitlements from this plan: the new plan gets its own copies of the source's feature and connector profiles, and its trial and storage ladder unless the payload states them

Response

Document created, URL follows

messagestring nullable

Changes

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