Search merchant data

Searches merchant data to return resources such as customers, invoices, orders, transactions.

SecuritySecretApiKey or JWT
Request
query Parameters
sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

q
string

Default search. Searches across resources and fields.

Responses
200

Results keyed by a resource.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
Array of objects (Customer)

List of returned customers.

Array
id
string <= 50 characters

ID of the customer.

email
string or null <email>

Customer's email address.

firstName
string or null

Customer's first name.

lastName
string or null

Customer's last name.

websiteId
string <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

(Vaulted instrument (object or null)) or (Alternative instrument (object or null)) or (Cash (object or null)) or (Check (object or null))

Default payment instrument information.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

object or null

Customer's primary address.

object (CustomerAverageValue)

Average customer value.

paymentCount
integer

Total number of approved payments made by the customer.

lastPaymentTime
string or null <date-time>

Time and date of the customer's last approved payment.

object (CustomerLifetimeRevenue)

Customer's lifetime revenue.

invoiceCount
integer

Total number of invoices issued to the customer. This value is auto-incrementing. If this value is 0, the record relates to a lead. A lead is a customer who has not made a payment yet. If this value is greater than or equal to 1 the record relates to a customer.

Array of objects (Tag)

List of customer tags.

revision
integer

Number of times the customer's data has been modified.

Use this value when analyzing webhook data to determine if a change must take precedence over the current representation.

isEddRequired
boolean
Default: false

Specifies if Enhanced Due Diligence (EDD) is enabled for this customer. For more information, see Enhanced Due Diligence.

hasFulfilledKyc
boolean

Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.

organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of objects

Related links.

object

Embedded objects that are requested using the expand query string parameter.

Array of objects (Invoice)

List of returned invoices.

Array
currency
required
string = 3 characters

Currency code in ISO 4217 format.

websiteId
required
string (WebsiteId) <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

customerId
required
string <= 50 characters

ID of the customer resource.

id
string <= 50 characters

ID of the invoice.

invoiceNumber
integer

Auto-incrementing number based on the sequence of invoices for any particular customer.

subscriptionId
string <= 50 characters

ID of the related subscription order, if available. This field is null if there are no related subscription orders.

amount
number <double>

Amount of the invoice.

amountDue
number <double>

Amount that is due on the invoice.

subtotalAmount
number <double>

Subtotal amount of the invoice.

discountAmount
number <double>

Discount amount that is applied to the invoice.

object (Shipping)

Shipping settings.

object (InvoiceTax)

Invoice taxes.

object

Billing address of the invoice.

object

Delivery address of the invoice.

poNumber
string or null

Purchase order number that is displayed on the invoice.

notes
string

Notes for the customer that are displayed on the invoice.

Array of objects (InvoiceItem)

Invoice items array.

Array of objects

Discounts applied.

autopayScheduledTime
string <date-time>

Date and time when an automatic payment (autopay) is scheduled.

autopayRetryNumber
integer >= 0
Default: 0

Number of times that an automatic payment (autopay) has been attempted on an invoice.

status
string

Status of the invoice.

Enum: "draft" "unpaid" "paid" "partially-paid" "past-due" "abandoned" "voided" "partially-refunded" "refunded" "disputed"
delinquentCollectionPeriod
integer

Length of time, in days, between when the invoice is due and when the invoice is paid.

collectionPeriod
integer

Length of time, in days, between when the invoice is issued and when the invoice is paid.

abandonedTime
string <date-time>

Date and time when the invoice is abandoned.

voidedTime
string <date-time>

Date and time when the invoice is voided.

paidTime
string <date-time>

Date and time when the invoice is paid.

dueTime
string <date-time>

Date and time when the invoice is due for payment.

issuedTime
string <date-time>

Date and time when the invoice is issued.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

paymentFormUrl
string <url>

URL where the customer is redirected to pay the invoice using one of the methods which are available to the customer. This is an alternative to creating a new transaction with empty methods.

Array of objects (Transaction) <= 10 items

Invoice transactions array.

object

Invoice payment retry instruction. This object specifies how to proceed if a payment related to the invoice fails.

revision
integer

Number of times the invoice data has been modified.

Use the revision number when analyzing webhook data to determine if a change should take precedence over the current representation.

type
string

Type of invoice.

Enum: "initial" "renewal" "interim" "cancellation" "one-time" "refund" "charge" "one-time-sale"
dueReminderTime
string or null <date-time>

Date and time when a past due reminder event is triggered.

dueReminderNumber
integer or null

Number of past due reminder events that have been triggered.

organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of objects

Related links.

object

Embedded objects that are requested by the expand query parameter.

Array of objects (Subscription)

List of returned orders.

Array
orderType
required
string

Specifies the type of order. An order may be a subscription or a one-time purchase.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

websiteId
required
string <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

required
Array of objects (OrderItem) non-empty

Item details.

id
string <= 50 characters

ID of the order.

renewalReminderTime
string or null <date-time>

Date and time when the renewal reminder event triggers.

renewalReminderNumber
integer or null

Number of triggered renewal reminder events.

trialReminderTime
string or null <date-time>

Date and time when the trial reminder event triggers.

trialReminderNumber
integer or null

Number of triggered trial reminder events.

abandonReminderTime
string or null <date-time>

Date and time when the abandon order reminder event triggers.

abandonReminderNumber
integer or null

Number of abandon order reminder events that are triggered.

organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

status
string

Status of the subscription service. A subscription starts in the pending status, and becomes active when the service period begins.

Enum: "pending" "active" "abandoned" "canceled" "churned" "paused" "voided" "completed" "trial-ended"
inTrial
boolean

Specifies if the subscription is currently in a trial period.

object

Trial details. To use plan defaults do not send the trial key, or send a null value.

isTrialOnly
boolean
Default: false

Specifies if a subscription ends after a trial period. If this value is true, recurring settings are ignored.

object or null

Shifts issue time and due time of invoices for this subscription.

This setting overrides plan settings. To use plan settings, set this value to null.

To use multiple plans in one subscription, all plans must have the same billing period, this property enables the customer to subscribe to different plans.

object or null

Recurring interval to override plan settings. To use plan settings, set this value to null.

To use multiple plans in one subscription, all plans must have the same recurring period length.

autopay
boolean
Default: true

Specifies if payment attempts are made automatically. If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at paymentInstrumentId, or the default payment instrument on the subscription.

startTime
string or null <date-time>

Date and time when the subscription starts. If this value is null, the current time is used. This value cannot be more than one service period in the past.

endTime
string or null <date-time>

Date and time when the subscription ends.

renewalTime
string or null <date-time>

Date and time when the subscription renews.

rebillNumber
integer or null

Current billing period number.

Array of objects (UpcomingInvoiceItem)

Subscription line items which queue until the next renewal (or interim) invoice is issued for the subscription.

object

Subtotal of line items in this subscription (signed value). If credits exceed debits, this value is a negative number.

paymentInstrumentId
string or null <= 50 characters

ID of the payment instrument to use for autopay. If this value is not provided, or if the payment instrument is inactive, the customer's default payment instrument is used.

billingStatus
string

Billing status of the most recent invoice. This value may help you to determine if you should change the service status of the service, such as suspending the service.

Enum: "draft" "unpaid" "past-due" "abandoned" "paid" "voided" "refunded" "disputed" "partially-refunded" "partially-paid"
currency
string = 3 characters

Currency of the order.

initialInvoiceId
string or null <= 50 characters

ID of the initial invoice.

recentInvoiceId
string or null <= 50 characters

ID of the most recently issued invoice. The invoice might not be paid yet.

object or null

Delivery address of the order.

object or null

Billing address of the order.

activationTime
string or null <date-time>

Date and time when the order is activated.

voidTime
string or null <date-time>

Date and time when the order is voided.

abandonTime
string or null <date-time>

Date and time when the pending order is automatically abandoned. If this value is not passed during order creation, a pending order TTL setting is used to calculate the value.

poNumber
string or null

Purchase order number displayed on the issued invoices.

object (Shipping)

Shipping settings.

notes
string

Notes for the customer displayed on the order invoice.

canceledBy
string or null

Specifies who initiated the cancellation.

Enum: "merchant" "customer" "rebilly" null
cancelCategory
string or null

Category of the cancellation.

Enum: "billing-failure" "did-not-use" "did-not-want" "missing-features" "bugs-or-problems" "do-not-remember" "risk-warning" "contract-expired" "too-expensive" "never-started" … 3 more
cancelDescription
string or null <= 255 characters

Description of the cancellation reason in free form.

revision
integer

Number of times the order data has been modified.

The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.

object or null (Risk metadata)

Risk metadata. If this value is null, this field uses risk metadata that is captured when creating the payment token.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

object

Embedded objects that are requested by the expand query parameter.

Array of objects (Transaction)

List of returned transactions.

Array
id
string <= 50 characters

ID of the transaction.

websiteId
string <= 50 characters

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

customerId
string <= 50 characters

ID of the customer resource.

type
string

Type of transaction.

Enum: "3ds-authentication" "authorize" "capture" "credit" "refund" "sale" "setup" "void"
status
string

Status of the transaction.

Enum: "completed" "conn-error" "disputed" "never-sent" "offsite" "partially-refunded" "pending" "refunded" "sending" "suspended" … 6 more
result
string

Result of the transaction.

Enum: "abandoned" "approved" "canceled" "declined" "unknown"
amount
number <double>

Total amount of the transaction.

currency
string = 3 characters

Currency code in ISO 4217 format.

purchaseAmount
number <double>

Amount by which the purchase is completed. If an adjustment occurs, the purchased amount may differ from the requested amount.

purchaseCurrency
string = 3 characters

Currency code in ISO 4217 format.

requestAmount
number <double>

Amount of the payment request. If an adjustment occurs, the purchase amount may differ from the billing amount.

requestCurrency
string = 3 characters

Currency code in ISO 4217 format.

parentTransactionId
string or null <= 50 characters

ID of the parent transaction.

childTransactions
Array of strings (ResourceId)

IDs of child transactions.

invoiceIds
Array of strings (ResourceId)

Related invoice IDs.

subscriptionIds
Array of strings (ResourceId)

Subscription IDs of invoices that are related to the transaction.

planIds
Array of strings (ResourceId)

Plan IDs of orders that are related to the transaction.

isRebill
boolean

Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.

rebillNumber
integer

Rebill number of the transaction. A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.

object

Billing address.

has3ds
boolean

Specifies if the transaction uses 3D Secure.

object

Authentication object.

redirectUrl
string or null <uri>

URL where the end-user is redirected to when an offsite transaction is completed. The default value is the website URL.

retryNumber
integer

Position of the transaction in the sequence of retries.

isRetry
boolean

Specifies if a transaction is a retry.

billingDescriptor
string or null

Billing descriptor that appears on the periodic billing statement. For a credit card statement, this field commonly contains 12 or fewer characters.

description
string <= 255 characters

Description of the payment.

requestId
string

Request ID of the transaction. This ID must be unique within a 24 hour period. Use this field to prevent duplicated transactions.

hasAmountAdjustment
boolean

Specifies if the transaction has amount adjustment.

gatewayName
string or null

Name of the payment gateway that processed, or is selected to process, the transaction. This value is only available after a gateway is selected for the transaction.

Enum: "A1Gateway" "ACI" "Adyen" "Airpay" "AmazonPay" "AmexVPC" "ApcoPay" "AsiaPaymentGateway" "AstroPayCard" "AuthorizeNet" … 170 more
customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

processedTime
string <date-time>

Date and time when the transaction is processed.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

gatewayAccountId
string <= 50 characters

ID of the gateway account that processed the transaction.

gatewayTransactionId
string <= 50 characters

ID of the gateway transaction.

object

Related gateway information.

acquirerName
string or null

Acquirer name. This value is only available when a transaction uses a payment gateway. If a transaction does not use a payment gateway, this value is null.

Enum: "Adyen" "ACI" "Alipay" "AIB" "Airpay" "AmazonPay" "ApcoPay" "AsiaPaymentGateway" "AstroPay Card" "Awepay" … 169 more
method
string
Deprecated

Payment method.

Note: Use paymentInstrument.method instead.

Enum: "payment-card" "ach" "cash" "check" "paypal" "AdvCash" "Airpay" "Alfa-click" "Alipay" "AmazonPay" … 165 more
velocity
integer

Number of transactions by the same customer in the past 24 hours.

revision
integer

Number of times the transaction data has been modified.

This revision number is useful when analyzing webhook data to determine if the change takes precedence over the current representation.

object or null

Transaction reference data.

bin
string <bin>

Payment card Bank Identification Number (BIN).

Vaulted instrument (object) or Alternative instrument (object) or Cash (object) or Check (object) (PaymentInstrumentValueObject)

Default payment instrument information.

hasDcc
boolean

Specifies if Dynamic Currency Conversion (DCC) applies to the transaction.

object or null

Detailed Dynamic currency conversion (DCC). If DCC is not applied to the transaction, this value is null.

hasBumpOffer
boolean

Specifies if the transaction has a bump offer. A bump offer is a discount, purchase bonus, deal, that is offered to the customer during checkout.

object or null

Bump offer information. If the transaction does not have an associated bump offer, this value is null.

riskScore
integer

Risk score for the transaction.

object or null (Risk metadata)

Risk metadata used for 3D Secure and risk scoring.

notificationUrl
string or null <uri>

URL where a server-to-server POST notification is sent. This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.

Do not trust this notification alone, complete a GET request to confirm the result of the transaction. To ensure the request is not reattempted, when the result is confirmed, respond with a 2xx HTTP status code.

The following placeholders are available to use in this URI: {id} and {result}.

isDisputed
boolean

Specifies if a transaction is disputed.

disputeTime
string or null <date-time>

Date and time when the dispute is created. If the transaction is not disputed, this value is null.

disputeStatus
string or null

Status of the dispute.

Enum: null "response-needed" "under-review" "forfeited" "won" "lost" "unknown"
isReconciled
boolean

Specifies if the transaction is verified with gateway batch data.

isProcessedOutside
boolean

Specifies if the transaction is processed outside of Rebilly.

isMerchantInitiated
boolean

Specifies if the transaction is initiated by the merchant.

hadDiscrepancy
boolean

Specifies if the transaction is updated due to a discrepancy with its source of truth.

orderId
string
Deprecated

Order ID of the transaction. This ID must be unique within a 24 hour period.

Note: Use the requestId field instead.

arn
string or null

Acquirer reference number.

reportAmount
number <double>

Transaction amount converted to the report currency of the organization.

reportCurrency
string = 3 characters

Currency code in ISO 4217 format.

settlementTime
string or null <date-time>

Date and time when the transaction is settled by the banking institution.

discrepancyTime
string or null <date-time>

Date and time of the most recent discrepancy on the transaction.

object or null (LimitAmount)

Transaction amount limit information.

organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Array of objects

Related links.

object

Embedded objects that are requested by the expand query parameter.

searched
Array of strings

Names of searched resources. Includes all searched resources.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/search
Request samples
Response samples
application/json
[
  • {
    }
]