Studio Service

BillingSubscriptionFilter

BillingSubscriptionFilter

A filter to be used against BillingSubscription object types. All fields are combined with a logical ‘and.’

FieldTypeDescription
idStringFilterFilter by the object’s `id` field.
billingCustomerIdStringFilterFilter by the object’s `billingCustomerId` field.
orgIdUUIDFilterFilter by the object’s `orgId` field.
currencyCodeCurrencyCodeFilterFilter by the object’s `currencyCode` field.
planIdStringFilterFilter by the object’s `planId` field.
planQuantityIntFilterFilter by the object’s `planQuantity` field.
planUnitPriceIntFilterFilter by the object’s `planUnitPrice` field.
planAmountIntFilterFilter by the object’s `planAmount` field.
statusStringFilterFilter by the object’s `status` field.
remainingBillingCyclesIntFilterFilter by the object’s `remainingBillingCycles` field.
poNumberStringFilterFilter by the object’s `poNumber` field.
paymentSourceIdStringFilterFilter by the object’s `paymentSourceId` field.
autoCollectionStringFilterFilter by the object’s `autoCollection` field.
dueInvoicesCountIntFilterFilter by the object’s `dueInvoicesCount` field.
totalDuesIntFilterFilter by the object’s `totalDues` field.
baseCurrencyCodeCurrencyCodeFilterFilter by the object’s `baseCurrencyCode` field.
hasScheduledChangesBooleanFilterFilter by the object’s `hasScheduledChanges` field.
cfPrimaryStringFilterFilter by the object’s `cfPrimary` field.
dueSinceDatetimeFilterFilter by the object’s `dueSince` field.
trialStartDatetimeFilterFilter by the object’s `trialStart` field.
trialEndDatetimeFilterFilter by the object’s `trialEnd` field.
currentTermStartDatetimeFilterFilter by the object’s `currentTermStart` field.
currentTermEndDatetimeFilterFilter by the object’s `currentTermEnd` field.
pauseDateDatetimeFilterFilter by the object’s `pauseDate` field.
resumeDateDatetimeFilterFilter by the object’s `resumeDate` field.
startDateDatetimeFilterFilter by the object’s `startDate` field.
startedAtDatetimeFilterFilter by the object’s `startedAt` field.
activatedAtDatetimeFilterFilter by the object’s `activatedAt` field.
cancelledAtDatetimeFilterFilter by the object’s `cancelledAt` field.
nextBillingAtDatetimeFilterFilter by the object’s `nextBillingAt` field.
createdAtDatetimeFilterFilter by the object’s `createdAt` field.
and[BillingSubscriptionFilter!]Checks for all expressions in this list.
or[BillingSubscriptionFilter!]Checks for any expressions in this list.
notBillingSubscriptionFilterNegates the expression.