Subscriptions

GET /accounting/subscriptions

Group: Accounting › Subscriptions · Operation ID: subscriptions

Returns a list of subscriptions. There is no get-one endpoint. For the full record, including the customer and legal entity, use POST accounting/subscriptions/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
autoRenew — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
renewalTerm — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
renewalPriceChangePercentage — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
termType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
subscriptionStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
serviceStartDateBasis — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
serviceActivationDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
serviceStartDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
serviceEndDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
submissionDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
cancellationDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
cancellationReason — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isCancellationEnabled — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
suspensionDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
suspensionReason — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isSuspensionEnabled — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, currency, autoRenew, renewalTerm, renewalPriceChangePercentage, termType, subscriptionStatus, serviceStartDateBasis, serviceActivationDate, serviceStartDate, serviceEndDate, submissionDate, cancellationDate, cancellationReason, isCancellationEnabled, suspensionDate, suspensionReason, isSuspensionEnabled, annualRecurringRevenue, monthlyRecurringRevenue, totalUserCount, prepaidBalance, lastModifiedDate
Selectable: id, subscriptionNumber, customerName, currency, autoRenew, renewalTerm, renewalPriceChangePercentage, termType, subscriptionStatus, serviceStartDateBasis, serviceActivationDate, serviceStartDate, serviceEndDate, submissionDate, cancellationDate, cancellationReason, isCancellationEnabled, suspensionDate, suspensionReason, isSuspensionEnabled, externalSubscriptionId, annualRecurringRevenue, monthlyRecurringRevenue, totalUserCount, prepaidBalance, lastModifiedDate

Response

200 Success

Under data, an array of subscriptionsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the subscription.
`subscriptionNumber`	string or null	no	The subscription number, for example 'SUB-1', unique within the tenant. Absent until one has been assigned.
`customerName`	string or null	no	The display name of the customer this subscription belongs to.
`currency`	string	no	The currency of annualRecurringRevenue and monthlyRecurringRevenue. Format ISO 4217, for example 'USD'.
`autoRenew`	boolean or null	no	Whether the subscription renews automatically at the end of its term.
`renewalTerm`	number or null	no	The length of the auto-renewal term, in the subscription's term unit.
`renewalPriceChangePercentage`	string (decimal) or null	no	The percentage the price is adjusted by on renewal. It is a percentage, not an amount, so it has no currency.
`termType`	string	no	The contract term structure. Possible values: 'termed', 'evergreen'.
`subscriptionStatus`	string or null	no	The subscription's lifecycle status, derived from the status of its lines. Possible values: 'pendingActivation', 'notStarted', 'active', 'pendingOrderApproval', 'canceled', 'suspended'.
`serviceStartDateBasis`	string or null	no	How the service start date is determined. Possible values: 'fixedDate', 'serviceActivation'.
`serviceActivationDate`	string (date) or null	no	The date service was activated, when serviceStartDateBasis is 'serviceActivation'. Format YYYY-MM-DD.
`serviceStartDate`	string (date) or null	no	The earliest service start date across the subscription's lines. Format YYYY-MM-DD.
`serviceEndDate`	string (date) or null	no	The latest service end date across the subscription's lines. Format YYYY-MM-DD.
`submissionDate`	string (date) or null	no	The date the subscription's originating sales order was submitted. Format YYYY-MM-DD.
`cancellationDate`	string (date) or null	no	The date from which the subscription is or will be canceled. Absent when no cancellation has been recorded. Format YYYY-MM-DD.
`cancellationReason`	string or null	no	The reason code for the cancellation. Possible values: 'noReasonGiven', 'budgetary', 'movingToCompetitors', 'lowCustomerSatisfaction', 'bankruptcy', 'acquisitionMerger'. Absent when the subscription has not been canceled.
`isCancellationEnabled`	boolean or null	no	Whether the cancellation procedure has been applied to this subscription.
`suspensionDate`	string (date) or null	no	The date from which the subscription is or will be suspended. Absent when no suspension has been recorded. Format YYYY-MM-DD.
`suspensionReason`	string or null	no	The reason code for the suspension. Possible values: 'unpaidBalance', 'invalidPaymentMethod'. Absent when the subscription has not been suspended.
`isSuspensionEnabled`	boolean or null	no	Whether the suspension process is enabled for this subscription.
`externalSubscriptionId`	string or null	no	The subscription's identifier in an external system. Absent when none was recorded at creation.
`annualRecurringRevenue`	string (decimal) or null	no	The annualized recurring revenue, in the subscription's currency: the sum of each active line's annual recurring revenue.
`monthlyRecurringRevenue`	string (decimal) or null	no	The monthly recurring revenue, in the subscription's currency: the sum of each active line's monthly recurring revenue.
`totalUserCount`	string (decimal) or null	no	The total active user or seat count across the subscription's active lines. It is a count, not a currency amount.
`prepaidBalance`	string (decimal) or null	no	The remaining prepaid balance available to this subscription, summed across its prepaid balance accesses. It is a drawdown counter, not a currency amount.
`lastModifiedDate`	string (date-time)	no	The date and time the subscription record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error