Billing

Retrieve all plans.

get/api/v1/billing/plans

Request

Base URL: https://go.outseta.com
URL: https://go.outseta.com/api/v1/billing/plans
Auth: none declared

Query parameters

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "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.