Billing

Add a new plan.

post/api/v1/billing/plans

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/billing/plans
Auth: one of:
- HTTP bearer
- API key in header Authorization

Request body

Uidstring nullable

_objectTypestring nullable

Createdstring date-time required

Updatedstring date-time required

ActivityEventDataunknown

Namestring nullable

Descriptionstring nullable

AccountRegistrationMode1 | 2

1 - Individual, 2 - Team

IsQuantityEditableboolean required

MinimumQuantityinteger

MaximumPeopleinteger nullable

MonthlyRatenumber

AnnualRatenumber

QuarterlyRatenumber

OneTimeRatenumber

SetupFeenumber

SkipSetupFeeOnPlanChangeboolean

IsTaxableboolean required

IsActiveboolean

IsPerUserboolean

RequirePaymentInformationboolean

TrialPeriodDaysinteger

TrialUntilDatestring date-time nullable

ExpiresAfterMonthsinteger

ExpirationDatestring date-time nullable

PostLoginPathstring nullable

StripeTaxCodeIdstring nullable

UnitOfMeasurestring nullable

NumberOfSubscriptionsinteger nullable

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "Name": "string",
  "Description": "string",
  "PlanFamily": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "Name": "string",
    "IsActive": false,
    "IsDefault": false,
    "Plans": []
  },
  "AccountRegistrationMode": 1,
  "IsQuantityEditable": false,
  "MinimumQuantity": 0,
  "MaximumPeople": 0,
  "MonthlyRate": 0,
  "AnnualRate": 0,
  "QuarterlyRate": 0,
  "OneTimeRate": 0,
  "SetupFee": 0,
  "SkipSetupFeeOnPlanChange": false,
  "IsTaxable": false,
  "IsActive": false,
  "IsPerUser": false,
  "RequirePaymentInformation": false,
  "TrialPeriodDays": 0,
  "TrialUntilDate": "string",
  "ExpiresAfterMonths": 0,
  "ExpirationDate": "string",
  "PostLoginPath": "string",
  "StripeTaxCodeId": "string",
  "UnitOfMeasure": "string",
  "PlanAddOns": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Plan": {},
      "AddOn": {},
      "IsUserSelectable": false
    }
  ],
  "ContentGroups": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Name": "string",
      "AccessDeniedPath": "string",
      "ContentGroupItems": [],
      "AllowedPlans": [],
      "AllowedProducts": [],
      "AllowedAddOns": []
    }
  ],
  "NumberOfSubscriptions": 0
}

Response