Billing

Retrieve all subscriptions.

Admins and API key callers see every subscription; non-admin users see only subscriptions on accounts they are related to. That scope is determined by the auth token and cannot be widened by the caller. Optionally pass Account.PersonAccount.Person.Uid as a query parameter to narrow the results to a specific person.

get/api/v1/billing/subscriptions

Request

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

Query parameters

currentstring nullable

Pass 1 to return only the most recent subscription per account, expired or not

statusstring nullable

Filters by the subscription's lifecycle: current, future, or past

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": {},
      "BillingRenewalTerm": 1,
      "Account": {},
      "Plan": {},
      "Quantity": 0,
      "StartDate": "string",
      "EndDate": "string",
      "ExpirationDate": "string",
      "RenewalDate": "string",
      "NewRequiredQuantity": 0,
      "IsPlanUpgradeRequired": false,
      "PlanUpgradeRequiredMessage": "string",
      "SubscriptionAddOns": [],
      "DiscountCouponSubscriptions": [],
      "DiscountCode": "string",
      "DiscountCouponExpirationDate": "string",
      "LatestInvoice": {},
      "Rate": 0
    }
  ]
}

Changes

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