Skip to main content

SearchableSubscriptionFilterInput

OpenSearch-style filter for subscriptions. Combine fields and use and/or/not for composition.

input SearchableSubscriptionFilterInput {
  id: SearchableIDFilterInput
  createdAt: SearchableIntFilterInput
  updatedAt: SearchableIntFilterInput
  amount: SearchableIntFilterInput
  currency: SearchableStringFilterInput
  description: SearchableStringFilterInput
  descriptor: SearchableStringFilterInput
  lastOrderId: SearchableStringFilterInput
  sequenceId: SearchableStringFilterInput
  status: SearchableStringFilterInput
  interval: SearchableStringFilterInput
  intervalCount: SearchableIntFilterInput
  lastPaymentId: SearchableIDFilterInput
  lastPaymentStatus: SearchableStringFilterInput
  lastPaymentStatusCode: SearchableStringFilterInput
  customerEmail: SearchableStringFilterInput
  customerName: SearchableStringFilterInput
  customerPhone: SearchableStringFilterInput
  paymentMethodMethod: SearchableStringFilterInput
  paymentMethodCardBrand: SearchableStringFilterInput
  paymentMethodCardLast4: SearchableStringFilterInput
  paymentMethodCardType: SearchableStringFilterInput
  paymentMethodCardThreeDSecure: SearchableBooleanFilterInput
  paymentMethodCardThreeDSecureVersion: SearchableStringFilterInput
  paymentMethodCardThreeDSecureFlow: SearchableStringFilterInput
  paymentMethodCardTokenizationMethod: SearchableStringFilterInput
  traceDetailsSource: SearchableStringFilterInput
  storeId: SearchableStringFilterInput
  and: [SearchableSubscriptionFilterInput]
  or: [SearchableSubscriptionFilterInput]
  not: SearchableSubscriptionFilterInput
}

Fields​

SearchableSubscriptionFilterInput.id ● SearchableIDFilterInput input​

Filter by subscription ID.

SearchableSubscriptionFilterInput.createdAt ● SearchableIntFilterInput input​

Filter by creation time (unix seconds). Use range: [from, to] for date filtering.

SearchableSubscriptionFilterInput.updatedAt ● SearchableIntFilterInput input​

Filter by last-update time (unix seconds). Use range: [from, to] for date filtering.

SearchableSubscriptionFilterInput.amount ● SearchableIntFilterInput input​

Filter by recurring amount (minor units).

SearchableSubscriptionFilterInput.currency ● SearchableStringFilterInput input​

Filter by currency (ISO 4217).

SearchableSubscriptionFilterInput.description ● SearchableStringFilterInput input​

Filter by description.

SearchableSubscriptionFilterInput.descriptor ● SearchableStringFilterInput input​

Filter by statement descriptor.

SearchableSubscriptionFilterInput.lastOrderId ● SearchableStringFilterInput input​

Filter by lastOrderId (the order ID attached to the last subscription payment).

SearchableSubscriptionFilterInput.sequenceId ● SearchableStringFilterInput input​

Filter by provider sequence ID.

SearchableSubscriptionFilterInput.status ● SearchableStringFilterInput input​

Filter by lifecycle status.

SearchableSubscriptionFilterInput.interval ● SearchableStringFilterInput input​

Filter by billing interval unit.

SearchableSubscriptionFilterInput.intervalCount ● SearchableIntFilterInput input​

Filter by interval count.

SearchableSubscriptionFilterInput.lastPaymentId ● SearchableIDFilterInput input​

Filter by lastPayment.id.

SearchableSubscriptionFilterInput.lastPaymentStatus ● SearchableStringFilterInput input​

Filter by lastPayment.status.

SearchableSubscriptionFilterInput.lastPaymentStatusCode ● SearchableStringFilterInput input​

Filter by lastPayment.statusCode.

SearchableSubscriptionFilterInput.customerEmail ● SearchableStringFilterInput input​

Filter by customer email.

SearchableSubscriptionFilterInput.customerName ● SearchableStringFilterInput input​

Filter by customer name.

SearchableSubscriptionFilterInput.customerPhone ● SearchableStringFilterInput input​

Filter by customer phone.

SearchableSubscriptionFilterInput.paymentMethodMethod ● SearchableStringFilterInput input​

Filter by paymentMethod.method.

SearchableSubscriptionFilterInput.paymentMethodCardBrand ● SearchableStringFilterInput input​

Filter by card brand.

SearchableSubscriptionFilterInput.paymentMethodCardLast4 ● SearchableStringFilterInput input​

Filter by card last 4 digits.

SearchableSubscriptionFilterInput.paymentMethodCardType ● SearchableStringFilterInput input​

Filter by card funding type.

SearchableSubscriptionFilterInput.paymentMethodCardThreeDSecure ● SearchableBooleanFilterInput input​

Filter by 3DS-performed flag.

SearchableSubscriptionFilterInput.paymentMethodCardThreeDSecureVersion ● SearchableStringFilterInput input​

Filter by 3DS protocol version.

SearchableSubscriptionFilterInput.paymentMethodCardThreeDSecureFlow ● SearchableStringFilterInput input​

Filter by 3DS flow.

SearchableSubscriptionFilterInput.paymentMethodCardTokenizationMethod ● SearchableStringFilterInput input​

Filter by tokenization wallet.

SearchableSubscriptionFilterInput.traceDetailsSource ● SearchableStringFilterInput input​

Filter by integration source (e.g. dashboard, api).

SearchableSubscriptionFilterInput.storeId ● SearchableStringFilterInput input​

Filter by store ID.

SearchableSubscriptionFilterInput.and ● [SearchableSubscriptionFilterInput] list input​

All sub-filters must match.

SearchableSubscriptionFilterInput.or ● [SearchableSubscriptionFilterInput] list input​

At least one sub-filter must match.

SearchableSubscriptionFilterInput.not ● SearchableSubscriptionFilterInput input​

Sub-filter must not match.

Member Of​

SearchableSubscriptionFilterInput input ● subscriptions query