Billing

Retrieve a subscription add-on.

get/api/v1/billing/subscriptionaddons/{subscriptionAddOnUid}

Request

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

Path parameters

subscriptionAddOnUidstring nullable required

The subscription add-on's unique identifier

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
BillingRenewalTerm1 | 2 | 3 | 4

1 - Monthly, 2 - Yearly, 3 - Quarterly, 4 - One Time

Quantityinteger nullable
StartDatestring date-time
EndDatestring date-time nullable
ExpirationDatestring date-time nullable
RenewalDatestring date-time nullable
NewRequiredQuantityinteger nullable
Ratenumber nullable

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "BillingRenewalTerm": 1,
  "Subscription": {
    "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
  },
  "AddOn": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "Name": "string",
    "BillingAddOnType": 1,
    "IsQuantityEditable": false,
    "MinimumQuantity": 0,
    "MonthlyRate": 0,
    "AnnualRate": 0,
    "SetupFee": 0,
    "UnitOfMeasure": "string",
    "IsTaxable": false,
    "IsBilledDuringTrial": false,
    "ExpiresAfterMonths": 0,
    "ExpirationDate": "string",
    "StripeTaxCodeId": "string",
    "PlanAddOns": [],
    "ContentGroups": [],
    "IsPerUser": false,
    "QuarterlyRate": 0,
    "OneTimeRate": 0,
    "SubscriptionCount": 0,
    "Quantity": 0
  },
  "Quantity": 0,
  "StartDate": "string",
  "EndDate": "string",
  "ExpirationDate": "string",
  "RenewalDate": "string",
  "NewRequiredQuantity": 0,
  "Rate": 0
}

Changes

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