BillingSubscriptionFilter
BillingSubscriptionFilter
A filter to be used against BillingSubscription object types. All fields are combined with a logical ‘and.’
| Field | Type | Description | |
|---|---|---|---|
| id | StringFilter | Filter by the object’s `id` field. | |
| billingCustomerId | StringFilter | Filter by the object’s `billingCustomerId` field. | |
| orgId | UUIDFilter | Filter by the object’s `orgId` field. | |
| raw | JSONFilter | Filter by the object’s `raw` field. | |
| currencyCode | CurrencyCodeFilter | Filter by the object’s `currencyCode` field. | |
| planId | StringFilter | Filter by the object’s `planId` field. | |
| planQuantity | IntFilter | Filter by the object’s `planQuantity` field. | |
| planUnitPrice | IntFilter | Filter by the object’s `planUnitPrice` field. | |
| planAmount | IntFilter | Filter by the object’s `planAmount` field. | |
| status | StringFilter | Filter by the object’s `status` field. | |
| remainingBillingCycles | IntFilter | Filter by the object’s `remainingBillingCycles` field. | |
| poNumber | StringFilter | Filter by the object’s `poNumber` field. | |
| paymentSourceId | StringFilter | Filter by the object’s `paymentSourceId` field. | |
| autoCollection | StringFilter | Filter by the object’s `autoCollection` field. | |
| dueInvoicesCount | IntFilter | Filter by the object’s `dueInvoicesCount` field. | |
| totalDues | IntFilter | Filter by the object’s `totalDues` field. | |
| baseCurrencyCode | CurrencyCodeFilter | Filter by the object’s `baseCurrencyCode` field. | |
| hasScheduledChanges | BooleanFilter | Filter by the object’s `hasScheduledChanges` field. | |
| cfPrimary | StringFilter | Filter by the object’s `cfPrimary` field. | |
| dueSince | DatetimeFilter | Filter by the object’s `dueSince` field. | |
| trialStart | DatetimeFilter | Filter by the object’s `trialStart` field. | |
| trialEnd | DatetimeFilter | Filter by the object’s `trialEnd` field. | |
| currentTermStart | DatetimeFilter | Filter by the object’s `currentTermStart` field. | |
| currentTermEnd | DatetimeFilter | Filter by the object’s `currentTermEnd` field. | |
| pauseDate | DatetimeFilter | Filter by the object’s `pauseDate` field. | |
| resumeDate | DatetimeFilter | Filter by the object’s `resumeDate` field. | |
| startDate | DatetimeFilter | Filter by the object’s `startDate` field. | |
| startedAt | DatetimeFilter | Filter by the object’s `startedAt` field. | |
| activatedAt | DatetimeFilter | Filter by the object’s `activatedAt` field. | |
| cancelledAt | DatetimeFilter | Filter by the object’s `cancelledAt` field. | |
| nextBillingAt | DatetimeFilter | Filter by the object’s `nextBillingAt` field. | |
| createdAt | DatetimeFilter | Filter by the object’s `createdAt` field. | |
| metaData | JSONFilter | Filter by the object’s `metaData` field. | |
| and | [BillingSubscriptionFilter!] | Checks for all expressions in this list. | |
| or | [BillingSubscriptionFilter!] | Checks for any expressions in this list. | |
| not | BillingSubscriptionFilter | Negates the expression. | |