Billing

Retrieve the associations between plans and add-ons.

Standard filtering applies, so the associations of a single plan are retrieved with ?Plan.Uid={planUid} and those of a single add-on with ?AddOn.Uid={addOnUid}. A PlanAddOns collection nested inside a plan or an add-on holds at most 100 entries, so a plan with more add-ons than that is read in full through this endpoint, which is paginated and has no such maximum.

get/api/v1/billing/planaddons

Request

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

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": {},
      "Plan": {},
      "AddOn": {},
      "IsUserSelectable": false
    }
  ]
}

Changes

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