Billing

Add a new plan family.

post/api/v1/billing/planfamilies

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/billing/planfamilies
  • 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
SchemaLessDataobject nullable
Namestring nullable
IsActiveboolean
IsDefaultboolean

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "SchemaLessData": {},
  "Name": "string",
  "IsActive": false,
  "IsDefault": false,
  "Plans": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Name": "string",
      "Description": "string",
      "PlanFamily": {},
      "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": [],
      "ContentGroups": [],
      "NumberOfSubscriptions": 0
    }
  ]
}

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
SchemaLessDataobject nullable
Namestring nullable
IsActiveboolean
IsDefaultboolean

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "SchemaLessData": {},
  "Name": "string",
  "IsActive": false,
  "IsDefault": false,
  "Plans": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Name": "string",
      "Description": "string",
      "PlanFamily": {},
      "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": [],
      "ContentGroups": [],
      "NumberOfSubscriptions": 0
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.