# Search merchant data

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

Endpoint: GET /search
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with -. Multiple fields can be sorted by separating each with ,.

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `q` (string)
    Default search.
Searches across resources and fields.

## Response 200 fields (application/json):

  - `customers` (array)
    List of returned customers.

  - `customers.id` (string)
    ID of the customer.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `customers.email` (string,null)
    Customer's email address.

  - `customers.firstName` (string,null)
    Customer's first name.

  - `customers.lastName` (string,null)
    Customer's last name.

  - `customers.websiteId` (string)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"

  - `customers.defaultPaymentInstrument` (object,null) — one of:
    - Vaulted payment instrument:
      - `method` (string, required)
        Payment method supported vault.
For more information, see [Payment instrument](https://www.rebilly.com/catalog/all/payment-instruments).
        Enum: "payment-card", "ach", "paypal"
      - `paymentInstrumentId` (string, required)
        ID of the payment instrument.
        Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
    - Alternative instrument:
      - `method` (string, required)
        Payment method.
        Enum: "payment-card", "ach", "cash", "check", "paypal", "AdvCash", "Aera", "Affirm", "Afterpay", "Aircash", "Airpay", "Alfa-click", "Alipay", "AmazonPay", "Apple Pay", "AstroPay Card", "AstroPay-GO", "BankSEND", "BankReferenced", "bank-transfer", "bank-transfer-2", "bank-transfer-3", "bank-transfer-4", "bank-transfer-5", "bank-transfer-6", "bank-transfer-7", "bank-transfer-8", "bank-transfer-9", "Baloto", "Beeline", "Belfius-direct-net", "bitcoin", "Bizum", "Blik", "Boleto", "Boleto-2", "Boleto-3", "cash-deposit", "CASHlib", "CashToCode", "CCAvenue", "China UnionPay", "Clearpay", "Cleo", "CODVoucher", "Conekta-oxxo", "Conekta-spei", "cryptocurrency", "Cupon-de-pagos", "CyberSource", "Dimoco-pay-smart", "Directa24Card", "domestic-cards", "Efecty", "echeck", "ecoPayz", "ecoPayzTurkey", "ecoVoucher", "EPS", "ePay.bg", "Ethereum", "e-wallet", "ezyEFT", "eZeeWallet", "FasterPay", "Flexepin", "Giropay", "Google Pay", "Gpaysafe", "iCashOne Voucher", "iDebit", "iDEAL", "ING-homepay", "INOVAPAY-pin", "INOVAPAY-wallet", "InstaDebit", "InstantPayments", "instant-bank-transfer", "Interac-online", "Interac-eTransfer", "Interac-express-connect", "Interac", "invoice", "iWallet", "Jeton", "JetonCash", "jpay", "KakaoPay", "Khelocard", "Klarna", "KNOT", "Litecoin", "loonie", "LPG-online", "LPG-payment-card", "Matrix", "MaxiCash", "Megafon", "MercadoPago", "MiFinity-eWallet", "miscellaneous", "MobilePay", "Mollie", "Multibanco", "Bancontact", "Bancontact-mobile", "MTS", "MuchBetter", "MuchBetterVoucher", "MyFatoorah", "Neosurf", "Netbanking", "Neteller", "Nordea-Solo", "NordikCoin", "OchaPay", "online-bank-transfer", "Onlineueberweisen", "oriental-wallet", "OXXO", "P24", "Pagadito", "PagoEffectivo", "Pagsmile-lottery", "Pagsmile-deposit-express", "PayCash", "Payco", "Payeer", "PaymentAsia-crypto", "Paysafecard", "PayTabs", "Pay4Fun", "Paynote", "Paymero", "Paymero-QR", "PayU", "PayULatam", "Perfect-money", "Piastrix", "PIX", "PinPay", "phone", "PhonePe", "POLi", "PostFinance-card", "PostFinance-e-finance", "QIWI", "QPay", "QQPay", "Quickpay", "rapyd-checkout", "rebilly-hosted-payment-form", "Resurs", "reverse-withdrawal", "Ripple", "SafetyPay", "Samsung Pay", "SEPA", "Siirto", "Skrill", "Skrill Rapid Transfer", "SMSVoucher", "Sofort", "SparkPay", "SPEI", "swift-dbt", "Tele2", "Telr", "Terminaly-RF", "Tether", "ToditoCash-card", "Trustly", "Tupay", "TWINT", "UniCrypt", "UPayCard", "UPI", "USD-coin", "VCreditos", "VegaWallet", "VenusPoint", "Viva", "voucher", "voucher-2", "voucher-3", "voucher-4", "Wallet88", "Webmoney", "Webpay", "Webpay-2", "Webpay Card", "WeChat Pay", "XPay-P2P", "XPay-QR", "Yandex-money", "Zotapay", "Zimpler", "Zip"
      - `paymentInstrumentId` (string)
        ID of the payment instrument.
        Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
      - `reference` (string,null)
        Reference data.
This field is available only for the bank-transfer payment method.
    - Cash:
      - `method` (string, required)
        Enum: "cash"
      - `receivedBy` (string)
        Individual or entity that received the payment.
    - Check:
      - `method` (string, required)
        Enum: "check"
      - `reference` (string)
        Reference data.

  - `customers.preferredPayoutInstrumentId` (string,null)
    ID of the customer's preferred payment instrument for payouts.
    Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"

  - `customers.createdTime` (string)
    Date and time when the resource is created.
This value is set automatically when the resource is created.

  - `customers.updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `customers.customFields` (object)
    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](https://www.rebilly.com/catalog/all/custom-fields).

  - `customers.primaryAddress` (any)
    Customer's primary address.
    - `firstName` (string,null)
      Contact's first name.
      Example: "Benjamin"
    - `lastName` (string,null)
      Contact's last name.
      Example: "Franklin"
    - `organization` (string,null)
      Contact's organization.
      Example: "Rebilly"
    - `address` (string,null)
      First line of the contact's street address.
      Example: "36 Craven St"
    - `address2` (string,null)
      Second line of the contact's street address.
    - `city` (string,null)
      Contact's city of residence.
      Example: "Austin"
    - `region` (string,null)
      Contact's region of residence.
      Example: "Texas"
    - `country` (string,null)
      Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
      Example: "GB"
    - `postalCode` (string,null)
      Contact's postal code.
      Example: "WC2N 5NF"
    - `phoneNumbers` (array)
      List of phone numbers associated with the contact.
    - `phoneNumbers.label` (string, required)
      Phone number label or name.
      Example: "main"
    - `phoneNumbers.value` (string, required)
      Phone number value.
      Example: "1-512-777-0269"
    - `phoneNumbers.primary` (boolean)
      Specifies if the phone number is the contact's primary phone number.
      Example: true
    - `emails` (array)
      List of email addresses associated with the contact.
    - `emails.label` (string, required)
      Email label or name.
      Example: "main"
    - `emails.value` (string, required)
      Email address value.
      Example: "rebilly@example.com"
    - `emails.primary` (boolean)
      Specifies if the email address is the contact's primary email address.
      Example: true
    - `dob` (string,null)
      Contact's date of birth in ISO-8601 YYYY-MM-DD format.
      Example: "1980-04-01"
    - `jobTitle` (string,null)
      Contact's job title.
      Example: "CEO"
    - `hash` (string)
      Hash value for the contact.
Use this value to compare contacts for identical attribute values.
      Example: "056ae6d97c788b9e98b049ebafd7b229bf852221"

  - `customers.company` (object,null)
    Company information that is associated with the customer's primary email address domain.

This is a paid feature, to enable it [contact Rebilly](https://www.rebilly.com/support/).

  - `customers.company.name` (string,null)
    Name of the company.

  - `customers.company.domain` (string)
    Website domain of the company.

  - `customers.company.yearFounded` (number,null)
    Founding year of the company.

  - `customers.company.industry` (string,null)
    Industry the company is associated with.

  - `customers.company.employeesCount` (number,null)
    Number of employees in the company.

  - `customers.company.country` (string,null)
    Country where the company is based.

  - `customers.company.locality` (string,null)
    Locality or region where the company is based.

  - `customers.company._links` (array)

  - `customers.company._links.href` (string)
    Link URL.

  - `customers.company._links.rel` (string)
    Type of link.
    Enum: "linkedin"

  - `customers.averageValue` (object)
    Average customer value.

  - `customers.averageValue.currency` (string)
    Merchant's reporting currency.

  - `customers.averageValue.amount` (number)
    Average amount of approved payments in the merchant's reporting currency.

  - `customers.averageValue.amountUsd` (number)
    Average approved payment amount in USD.

  - `customers.paymentCount` (integer)
    Total number of approved payments made by the customer.
Payments are the result of sale or capture transactions.

  - `customers.lastPaymentTime` (string,null)
    Date and time when the customer made their last approved payment.
Payments are the result of sale or capture transactions.

  - `customers.lifetimeRevenue` (object)
    Customer's lifetime revenue.

  - `customers.lifetimeRevenue.currency` (string)
    Merchant's reporting currency.

  - `customers.lifetimeRevenue.amount` (number)
    Revenue amount in the merchant's reporting currency.

  - `customers.lifetimeRevenue.amountUsd` (number)
    Revenue amount in USD.

  - `customers.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.

  - `customers.tags` (array)
    List of customer tags.

  - `customers.tags.id` (string)
    ID of the tag.

  - `customers.tags.name` (string, required)
    Unique name for the tag.
Tag names are not case-sensitive.
    Example: "New"

  - `customers.tags.type` (string, required)
    Type of tag.
Tags of a specific type can only be assigned to corresponding entity types.
For example, you can only use customer tags on customers.
    Enum: "customer", "kyc-document", "aml-check"

  - `customers.tags.createdTime` (string)
    Date and time when the resource is created.
This value is set automatically when the resource is created.

  - `customers.tags.updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `customers.tags._links` (array)
    Related links.

  - `customers.tags._links.href` (string)
    Link URL.

  - `customers.tags._links.rel` (string)
    Type of link.
    Enum: "self"

  - `customers.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.

  - `customers.hasFulfilledKyc` (boolean)
    Specifies if the customer has accepted and reviewed identity and address documents, or an accepted credit file document.

  - `customers.organizationId` (string)
    Unique organization identifier.
An organization is an entity that represents a company.
For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "org_0YVDM8RC7GDADADSBSMW124JA8"

  - `customers.locale` (string,null)
    Language locale identifier in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.
    Example: "fr-FR"

  - `customers.taxNumbers` (array,null)
    Tax numbers of the customer.

  - `customers.taxNumbers.type` (string, required)
    Type of the tax number.
    Enum: "eu-vat", "other"

  - `customers.taxNumbers.value` (string, required)
    Value of the tax number.
    Example: "GB980780684"

  - `customers.taxNumbers.isDefault` (boolean)
    Determines if the tax number is selected as default to display on invoices.
    Example: true

  - `customers.taxNumbers.isValid` (boolean,null)
    Determines if the tax number passed the EU official [VIES validation](https://ec.europa.eu/taxation_customs/vies/#/vat-validation).
    Example: true

  - `customers.personId` (string,null)
    ID of the associated person.
    Example: "prs_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `customers.notificationEmails` (array)
    Additional email addresses for notification delivery.

  - `customers._links` (array)
    Related links.

  - `customers._links.href` (string)
    Link URL.

  - `customers._links.rel` (string)
    Type of link.
    Enum: "self", "attachments", "defaultPaymentInstrument", "leadSource", "website"

  - `customers._embedded` (object)
    Embedded objects that are requested using the expand query string parameter.

  - `customers._embedded.defaultPaymentInstrument` (object)

  - `customers._embedded.website` (object)

  - `customers._embedded.leadSource` (object)

  - `invoices` (array)
    List of returned invoices.

  - `invoices.id` (string)
    ID of the invoice.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `invoices.websiteId` (string, required)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).

  - `invoices.invoiceNumber` (integer)
    Auto-incrementing number based on the sequence of invoices for any particular customer.

  - `invoices.orderId` (string,null)
    ID of the order (experimental).
    Example: "ord_01HVKA5975PJBSQ1SX72G3MSZC"

  - `invoices.subscriptionId` (string)
    ID of the related subscription order, if available.
This field is null if there are no related subscription orders.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `invoices.quoteId` (string,null)
    ID of the related quote, if available.
This field is null if there are no related quotes.
    Example: "qt_01HXBZMEGPETPHJZH6V4RHBMA8"

  - `invoices.currency` (string, required)
    Currency code in ISO 4217 format.

  - `invoices.amount` (number)
    Amount of the invoice.

  - `invoices.amountDue` (number)
    Amount that is due on the invoice.

  - `invoices.subtotalAmount` (number)
    Subtotal amount of the invoice.

  - `invoices.discountAmount` (number)
    Discount amount that is applied to the invoice.

  - `invoices.shipping` (object) — one of (discriminator: calculator):
    Shipping settings.
    - manual:
      - `amount` (number, required)
        Shipping amount.
      - `calculator` (string, required)
        Shipping calculator.
        Enum: "manual"
    - rebilly:
      - `calculator` (string, required)
        Shipping calculator.
        Enum: "rebilly"
      - `rateId` (string,null)
        ID of the shipping rate.
If this value is not set,
the cheapest applicable shipping rate is used.
        Example: "shipping-123-456"
      - `amount` (number)
        Shipping amount which is calculated from [Shipping rates](https://www.rebilly.com/catalog/all/shipping-rates).

  - `invoices.tax` (object) — one of (discriminator: calculator):
    Taxes.
    - manual:
      - `calculator` (string, required)
        Type of tax calculator.
        Enum: same as `calculator` in "manual" (1 values)
      - `amount` (number)
        Total amount of taxes.
      - `items` (array, required)
        Taxes applied.
      - `items.amount` (number, required)
        Amount of the tax.
      - `items.description` (string, required)
        Description of the tax.
      - `items.rate` (number,null)
        Overall sales tax rate which includes state, county, city and district tax.
      - `items.stateAmount` (number,null)
        Amount of sales tax to collect for the state.
        Example: 0.94
      - `items.countyAmount` (number,null)
        Amount of sales tax to collect for the county.
        Example: 0.04
      - `items.cityAmount` (number,null)
        Amount of sales tax to collect for the city.
      - `items.specialDistrictAmount` (number,null)
        Amount of sales tax to collect for the special district.
        Example: 0.38
      - `items.stateRate` (number,null)
        State sales tax rate for given location.
      - `items.countyRate` (number,null)
        County sales tax rate for given location.
      - `items.cityRate` (number,null)
        City sales tax rate for given location.
      - `items.specialDistrictRate` (number,null)
        Special district sales tax rate for given location.
      - `items.jurisdictions` (object,null)
        Jurisdiction names for the invoice.
      - `items.jurisdictions.country` (string,null)
        Two-letter ISO country code for the provided location.
        Example: "US"
      - `items.jurisdictions.state` (string,null)
        Postal abbreviated state name for the provided location.
        Example: "CA"
      - `items.jurisdictions.county` (string,null)
        County name for the provided location.
        Example: "LOS ANGELES"
      - `items.jurisdictions.city` (string,null)
        City name for the provided location.
        Example: "LOS ANGELES"
    - rebilly-taxjar:
      - `calculator` (string, required)
        Type of tax calculator.
        Enum: "rebilly-taxjar"
      - `amount` (number)
        Total amount of taxes.
      - `items` (array)
        Taxes applied and calculated based on the taxCategoryId of the related product.
      - `items.amount` (number, required)
        Amount of the tax.
      - `items.description` (string, required)
        Description of the tax.
      - `items.rate` (number,null)
        Overall sales tax rate which includes state, county, city and district tax.
      - `items.stateAmount` (number,null)
        Amount of sales tax to collect for the state.
        Example: 0.94
      - `items.countyAmount` (number,null)
        Amount of sales tax to collect for the county.
        Example: 0.04
      - `items.cityAmount` (number,null)
        Amount of sales tax to collect for the city.
      - `items.specialDistrictAmount` (number,null)
        Amount of sales tax to collect for the special district.
        Example: 0.38
      - `items.stateRate` (number,null)
        State sales tax rate for given location.
      - `items.countyRate` (number,null)
        County sales tax rate for given location.
      - `items.cityRate` (number,null)
        City sales tax rate for given location.
      - `items.specialDistrictRate` (number,null)
        Special district sales tax rate for given location.
      - `items.jurisdictions` (object,null)
        Jurisdiction names for the invoice.
      - `items.jurisdictions.country` (string,null)
        Two-letter ISO country code for the provided location.
        Example: "US"
      - `items.jurisdictions.state` (string,null)
        Postal abbreviated state name for the provided location.
        Example: "CA"
      - `items.jurisdictions.county` (string,null)
        County name for the provided location.
        Example: "LOS ANGELES"
      - `items.jurisdictions.city` (string,null)
        City name for the provided location.
        Example: "LOS ANGELES"
    - rebilly-avalara:
      - `calculator` (string, required)
        Type of tax calculator.
        Enum: "rebilly-avalara"
      - `amount` (number)
        Total amount of taxes.
      - `items` (array)
        Taxes applied and calculated based on the taxCategoryId of the related product.
      - `items.amount` (number, required)
        Amount of the tax.
      - `items.description` (string, required)
        Description of the tax.
      - `items.rate` (number,null)
        Overall sales tax rate which includes state, county, city and district tax.
      - `items.stateAmount` (number,null)
        Amount of sales tax to collect for the state.
        Example: 0.94
      - `items.countyAmount` (number,null)
        Amount of sales tax to collect for the county.
        Example: 0.04
      - `items.cityAmount` (number,null)
        Amount of sales tax to collect for the city.
      - `items.specialDistrictAmount` (number,null)
        Amount of sales tax to collect for the special district.
        Example: 0.38
      - `items.stateRate` (number,null)
        State sales tax rate for given location.
      - `items.countyRate` (number,null)
        County sales tax rate for given location.
      - `items.cityRate` (number,null)
        City sales tax rate for given location.
      - `items.specialDistrictRate` (number,null)
        Special district sales tax rate for given location.
      - `items.jurisdictions` (object,null)
        Jurisdiction names for the invoice.
      - `items.jurisdictions.country` (string,null)
        Two-letter ISO country code for the provided location.
        Example: "US"
      - `items.jurisdictions.state` (string,null)
        Postal abbreviated state name for the provided location.
        Example: "CA"
      - `items.jurisdictions.county` (string,null)
        County name for the provided location.
        Example: "LOS ANGELES"
      - `items.jurisdictions.city` (string,null)
        City name for the provided location.
        Example: "LOS ANGELES"

  - `invoices.organizationTaxIdNumber` (object,null)
    Organization tax ID number that is displayed on the invoice.

  - `invoices.organizationTaxIdNumber.type` (string, required)
    Type of the tax ID number.
    Enum: same as `customers.taxNumbers.type` (2 values)

  - `invoices.organizationTaxIdNumber.value` (string, required)
    Value of the tax ID number.
    Example: "GB980780684"

  - `invoices.customerTaxIdNumber` (object,null)
    Customer tax ID number that is displayed on the invoice.

  - `invoices.customerTaxIdNumber.type` (string, required)
    Type of the tax ID number.
    Enum: same as `customers.taxNumbers.type` (2 values)

  - `invoices.customerTaxIdNumber.value` (string, required)
    Value of the tax ID number.
    Example: "GB980780684"

  - `invoices.billingAddress` (object)
    Billing address of the invoice.
After the first payment is made for an invoice, this value cannot be changed.

  - `invoices.billingAddress.firstName` (string,null)
    Contact's first name.
    Example: "Benjamin"

  - `invoices.billingAddress.lastName` (string,null)
    Contact's last name.
    Example: "Franklin"

  - `invoices.billingAddress.organization` (string,null)
    Contact's organization.
    Example: "Rebilly"

  - `invoices.billingAddress.address` (string,null)
    First line of the contact's street address.
    Example: "36 Craven St"

  - `invoices.billingAddress.address2` (string,null)
    Second line of the contact's street address.

  - `invoices.billingAddress.city` (string,null)
    Contact's city of residence.
    Example: "Austin"

  - `invoices.billingAddress.region` (string,null)
    Contact's region of residence.
    Example: "Texas"

  - `invoices.billingAddress.country` (string,null)
    Contact's country of residence in ISO 3166 alpha-2 country code.
For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
    Example: "GB"

  - `invoices.billingAddress.postalCode` (string,null)
    Contact's postal code.
    Example: "WC2N 5NF"

  - `invoices.billingAddress.phoneNumbers` (array)
    List of phone numbers associated with the contact.

  - `invoices.billingAddress.phoneNumbers.label` (string, required)
    Phone number label or name.
    Example: "main"

  - `invoices.billingAddress.phoneNumbers.value` (string, required)
    Phone number value.
    Example: "1-512-777-0269"

  - `invoices.billingAddress.phoneNumbers.primary` (boolean)
    Specifies if the phone number is the contact's primary phone number.
    Example: true

  - `invoices.billingAddress.emails` (array)
    List of email addresses associated with the contact.

  - `invoices.billingAddress.emails.label` (string, required)
    Email label or name.
    Example: "main"

  - `invoices.billingAddress.emails.value` (string, required)
    Email address value.
    Example: "rebilly@example.com"

  - `invoices.billingAddress.emails.primary` (boolean)
    Specifies if the email address is the contact's primary email address.
    Example: true

  - `invoices.billingAddress.dob` (string,null)
    Contact's date of birth in ISO-8601 YYYY-MM-DD format.
    Example: "1980-04-01"

  - `invoices.billingAddress.jobTitle` (string,null)
    Contact's job title.
    Example: "CEO"

  - `invoices.billingAddress.hash` (string)
    Hash value for the contact.
Use this value to compare contacts for identical attribute values.
    Example: "056ae6d97c788b9e98b049ebafd7b229bf852221"

  - `invoices.deliveryAddress` (object)
    Delivery address of the invoice.

  - `invoices.poNumber` (string,null)
    Purchase order number that is displayed on the invoice.
    Example: "PO123456"

  - `invoices.notes` (string)
    Notes for the customer that are displayed on the invoice.

  - `invoices.items` (array)
    Invoice items array.

  - `invoices.items.id` (string)
    ID of the invoice item.
    Example: "ii_0YVFDEQS2KCFTBN9HXWJFY55GV"

  - `invoices.items.type` (string, required)
    Type of invoice item.
    Enum: "debit", "credit"

  - `invoices.items.description` (string)
    Description of the invoice item.

  - `invoices.items.unitPrice` (number, required)
    Unit price of the invoice item.

  - `invoices.items.quantity` (integer)
    Quantity of the invoice item.

  - `invoices.items.price` (number)
    Total price of the invoice item.

  - `invoices.items.productId` (string,null)
    ID of the product.
    Example: "prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"

  - `invoices.items.planId` (string,null)
    ID of the plan.
    Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"

  - `invoices.items.subscriptionId` (string,null)
    ID of the order.
    Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"

  - `invoices.items.discountAmount` (number)
    Discount amount applied to the invoice item.

  - `invoices.items.periodStartTime` (string,null)
    Date and time when the billing period starts.

  - `invoices.items.periodEndTime` (string,null)
    Date and time when the billing period ends.

  - `invoices.items.periodNumber` (integer,null)
    Billing period number that is associated with the invoice item.
For example, an invoice item for a service is included in billing period number 3.
The invoice item is only applied to billing period number 3.

  - `invoices.items.createdTime` (string)
    Date and time when the resource is created.
This value is set automatically when the resource is created.

  - `invoices.items.updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `invoices.items.tax` (any)
    Invoice item tax.
    - `amount` (number, required)
      Amount of the tax.
    - `description` (string, required)
      Description of the tax.
    - `rate` (number,null)
      Overall sales tax rate which includes state, county, city and district tax.
    - `stateAmount` (number,null)
      Amount of sales tax to collect for the state.
      Example: 0.94
    - `countyAmount` (number,null)
      Amount of sales tax to collect for the county.
      Example: 0.04
    - `cityAmount` (number,null)
      Amount of sales tax to collect for the city.
    - `specialDistrictAmount` (number,null)
      Amount of sales tax to collect for the special district.
      Example: 0.38
    - `stateRate` (number,null)
      State sales tax rate for given location.
    - `countyRate` (number,null)
      County sales tax rate for given location.
    - `cityRate` (number,null)
      City sales tax rate for given location.
    - `specialDistrictRate` (number,null)
      Special district sales tax rate for given location.
    - `jurisdictions` (object,null)
      Jurisdiction names for the invoice.
    - `jurisdictions.country` (string,null)
      Two-letter ISO country code for the provided location.
      Example: "US"
    - `jurisdictions.state` (string,null)
      Postal abbreviated state name for the provided location.
      Example: "CA"
    - `jurisdictions.county` (string,null)
      County name for the provided location.
      Example: "LOS ANGELES"
    - `jurisdictions.city` (string,null)
      City name for the provided location.
      Example: "LOS ANGELES"

  - `invoices.items._links` (array)
    Related links.

  - `invoices.items._links.href` (string)
    Link URL.

  - `invoices.items._links.rel` (string)
    Type of link.
    Enum: "self", "product", "subscription", "plan"

  - `invoices.items._embedded` (object)
    Embedded objects that are requested by the expand query parameter.

  - `invoices.items._embedded.product` (object)

  - `invoices.items._embedded.plan` (object)

  - `invoices.discounts` (array)
    Discounts applied.

  - `invoices.discounts.couponId` (string)
    ID of the coupon.
    Example: "cpn_0YVCNKF81GD778N4YNVGDJK558"

  - `invoices.discounts.redemptionId` (string)
    ID of the redemption.

  - `invoices.discounts.amount` (number)
    Total amount discounted by this coupon.

  - `invoices.discounts.description` (string)
    Description of the discount.

  - `invoices.discounts.context` (string)
    Context in which the discount applies.
    Enum: "items", "shipping", "items-and-shipping"

  - `invoices.autopayScheduledTime` (string,null)
    Date and time when an automatic payment (autopay) is scheduled.

  - `invoices.autopayRetryNumber` (integer)
    Number of times that an automatic payment (autopay) has been attempted on an invoice.

  - `invoices.status` (string)
    Status of the invoice.
    Enum: "draft", "quotation", "unpaid", "paid", "partially-paid", "past-due", "abandoned", "voided", "partially-refunded", "refunded", "disputed"

  - `invoices.delinquentCollectionPeriod` (integer)
    Length of time, in days, between when the invoice is due and when the invoice is paid.

  - `invoices.collectionPeriod` (integer)
    Length of time, in days, between when the invoice is issued and when the invoice is paid.

  - `invoices.abandonedTime` (string,null)
    Date and time when the invoice is abandoned.

  - `invoices.voidedTime` (string,null)
    Date and time when the invoice is voided.

  - `invoices.paidTime` (string,null)
    Date and time when the invoice is paid.

  - `invoices.dueTime` (string)
    Date and time when the invoice is due for payment.

  - `invoices.issuedTime` (string)
    Date and time when the invoice is issued.

  - `invoices.createdTime` (string)
    Date and time when the resource is created.
This value is set automatically when the resource is created.

  - `invoices.updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `invoices.paymentFormUrl` (string,null)
    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.

  - `invoices.creditMemoAllocations` (array)
    Credit memo allocations to an invoice.

  - `invoices.creditMemoAllocations.invoiceId` (string)
    ID of invoice to which the credit memo is allocated.
    Example: "in_0YVF9605RKC62BP14NE2R7V2XT"

  - `invoices.creditMemoAllocations.amount` (number)
    Amount of credit that is allocated from the credit memo to the invoice.
If the amount value is not supplied or exceeds the unused amount of the credit memo or the invoice due amount, the lesser of the following two values is used:
- The unused amount of the credit memo.
- The invoice due amount.

  - `invoices.creditMemoAllocations.currency` (string)
    Currency code in ISO 4217 format.

  - `invoices.creditMemoAllocations.createdTime` (string)
    Date and time at which a credit memo is allocated.

  - `invoices.creditMemoAllocations.updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `invoices.isNewOrder` (boolean)
    Specifies if the order is a new order.
    Example: true

  - `invoices.customerId` (string, required)
    ID of the customer resource.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `invoices.transactions` (array)
    Invoice transactions array.

  - `invoices.transactions.id` (string)
    ID of the transaction.

  - `invoices.transactions.websiteId` (string)
    ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"

  - `invoices.transactions.customerId` (string)
    ID of the customer resource.
    Example: "cus_0YV7DDSDD1C8DA64KHH2W33CPF"

  - `invoices.transactions.type` (string)
    Type of transaction.
    Enum: "3ds-authentication", "authorize", "capture", "credit", "refund", "sale", "setup", "void"

  - `invoices.transactions.status` (string)
    Status of the transaction.
    Enum: "completed", "conn-error", "disputed", "never-sent", "offsite", "partially-refunded", "pending", "refunded", "sending", "timeout", "voided", "waiting-approval", "waiting-capture", "waiting-gateway", "waiting-refund"

  - `invoices.transactions.result` (string)
    Result of the transaction.
    Enum: "abandoned", "approved", "canceled", "declined", "unknown"

  - `invoices.transactions.amount` (number)
    Total amount of the transaction.

  - `invoices.transactions.currency` (string)
    Currency code in ISO 4217 format.

  - `invoices.transactions.purchaseAmount` (number)
    Amount by which the purchase is completed.
If an adjustment occurs, the purchased amount may differ from the requested amount.

  - `invoices.transactions.purchaseCurrency` (string)
    Currency code in ISO 4217 format.

  - `invoices.transactions.requestAmount` (number)
    Amount of the payment request.
If an adjustment occurs,
the purchase amount may differ from the billing amount.

  - `invoices.transactions.requestCurrency` (string)
    Currency code in ISO 4217 format.

  - `invoices.transactions.parentTransactionId` (string)
    ID of the parent transaction.
    Example: "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"

  - `invoices.transactions.childTransactions` (array)
    IDs of child transactions.
    Example: ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"]

  - `invoices.transactions.invoiceIds` (array)
    Related invoice IDs.
    Example: ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"]

  - `invoices.transactions.subscriptionIds` (array)
    Subscription IDs of invoices that are related to the transaction.
    Example: ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"]

  - `invoices.transactions.planIds` (array)
    Plan IDs of orders that are related to the transaction.
    Example: ["4f6cf35x-2c4y-483z-a0a9-158621f77a21"]

  - `invoices.transactions.isRebill` (boolean)
    Specifies if the transaction is one of a number of recurring payments in a subscription, excluding trials or setup fees.

  - `invoices.transactions.rebillNumber` (integer)
    Rebill number of the transaction.
A rebill number is the number of recurring payments in a subscription, excluding trials or setup fees.

  - `invoices.transactions.billingAddress` (object)
    Billing address.

  - `invoices.transactions.has3ds` (boolean)
    Specifies if the transaction uses 3D Secure.

  - `invoices.transactions.3ds` (object)
    Authentication object.
For more information, see [3D Secure (3DS)](https://www.rebilly.com/docs/docs/settings/3ds/).

  - `invoices.transactions.3ds.server` (string)
    Name of the 3D Secure server.

  - `invoices.transactions.3ds.version` (string)
    Version of 3D Secure.
    Enum: "1.0.2", "2.1.0", "2.2.0"

  - `invoices.transactions.3ds.enrolled` (string)
    Specifies if the cardholder is enrolled in 3D Secure.
    Enum: "yes", "no", "invalid card/timeout", "unavailable"

  - `invoices.transactions.3ds.authenticated` (string)
    Authentication response status for 3D Secure.
    Enum: "yes", "no", "not applicable", "attempted"

  - `invoices.transactions.3ds.liability` (string)
    Enum: "protected", "not protected", "protected (attempt)"

  - `invoices.transactions.3ds.flow` (string)
    Authentication flow for 3D Secure 2.
    Enum: "frictionless", "challenge"

  - `invoices.transactions.3ds.isDowngraded` (boolean)
    Specifies if 3D Secure 2 is attempted and downgraded to 3D Secure 1.

  - `invoices.transactions.redirectUrl` (string,null)
    URL where the end-user is redirected to when an offsite transaction is completed.
The default value is the website URL.

  - `invoices.transactions.retryNumber` (integer)
    Position of the transaction in the sequence of retries.

  - `invoices.transactions.isRetry` (boolean)
    Specifies if a transaction is a retry.

  - `invoices.transactions.billingDescriptor` (string,null)
    Billing descriptor that appears on the periodic billing statement.
For a credit card statement, this field commonly contains 12 or fewer characters.

  - `invoices.transactions.description` (string)
    Description of the payment.

  - `invoices.transactions.requestId` (string)
    Request ID of the transaction.
This ID must be unique within a 24-hour period.
Use this field to prevent duplicate transactions.

  - `invoices.transactions.hasAmountAdjustment` (boolean)
    Specifies if the transaction has amount adjustment.

  - `invoices.transactions.gatewayName` (string,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", "Aera", "Aircash", "Airpay", "Airwallex", "AsiaPay", "AmazonPay", "AmexVPC", "Antom", "ApcoPay", "AsiaPaymentGateway", "AstroPayCard", "AuthorizeNet", "Awepay", "Bambora", "BankSEND", "BitPay", "BlueSnap", "BraintreePayments", "Buckaroo", "BVNK", "Cardknox", "Cashflows", "CASHlib", "Cashterminal", "CashToCode", "CauriPayment", "Cayan", "CCAvenue", "Chase", "CheckoutCom", "Chillstock", "Circle", "Citadel", "Clearhaus", "Cleo", "CODVoucher", "Coinbase", "CoinGate", "CoinPayments", "Conekta", "Coppr", "Credorax", "Cryptomus", "Cryptonator", "CyberSource", "DataCash", "Dengi", "Dimoco", "Directa24", "dLocal", "Dragonphoenix", "Dropayment", "EasyPayDirect", "EBANX", "ecoPayz", "ecoPayzTurkey", "EcorePay", "Elavon", "Euteller", "eMerchantPay", "EMS", "ePay", "EPG", "EPro", "Ezeebill", "eZeeWallet", "ezyEFT", "FasterPay", "Finrax", "Flexepin", "FinTecSystems", "FundSend", "Forte", "gate2way", "GET", "Gigadat", "GlobalOnePay", "GoCardless", "Gooney", "Gpaysafe", "Greenbox", "HiPay", "iCashOne", "iCanPay", "ICEPAY", "iCheque", "iDebit", "Ilixium", "Ingenico", "INOVAPAY", "Inovio", "Intuit", "InstaDebit", "IpayOptions", "Isx", "JetPay", "Jeton", "JPMOrbital", "Khelocard", "Klarna", "Konnektive", "Kushki", "LaCore", "Limepay", "Loonio", "loonie", "LPG", "MaxiCash", "MercadoPago", "MiFinity", "Mollie", "MobilePay", "Moneris", "Monolo", "MonRem", "MtaPay", "MuchBetter", "MuchBetterGateway", "MyFatoorah", "Naewe", "Neosurf", "Netbanking", "Neteller", "NGenius", "NinjaWallet", "NMI", "NordikCoin", "NOWPayments", "NuaPay", "OchaPay", "OmniMatrix", "Onlineueberweisen", "OnRamp", "Orbital", "Pagadito", "Pagsmile", "Panamerican", "ParamountCommerce", "ParamountEft", "ParamountInterac", "PandaGateway", "Pay4Fun", "Paybilt", "PayCash", "Paycly", "PayClub", "PayCom", "PayEcards", "Payeezy", "Payflow", "Paynote", "PaymentAsia", "PaymenTechnologies", "PaymentsOS", "Paymero", "PayPal", "Payper", "Payr", "PayRedeem", "PayRetailers", "Paysafe", "Paysafecard", "Paysafecash", "PayTabs", "PayU", "PayULatam", "Payvision", "PayXpert", "PharosPayments", "Piastrix", "Pin4Pay", "Plugnpay", "PostFinance", "Powertranz", "PPRO", "Prosa", "PSiGate", "Quickpay", "Rapyd", "Realex", "Realtime", "Redsys", "Rotessa", "RPN", "Safecharge", "SaltarPay", "Sagepay", "SeamlessChex", "SecureTrading", "SecurionPay", "Skrill", "SmartInvoice", "SMSVoucher", "Sofort", "SparkPay", "Splitit", "StaticGateway", "STPMexico", "Stripe", "Tabby", "Telr", "TestProcessor", "ToditoCash", "Triple000", "Truevo", "TrustsPay", "Trustly", "TWINT", "Txn", "Unlimit", "UPayCard", "USAePay", "VantivLitle", "vegaaH", "VCreditos", "VegaWallet", "Viva", "Wallet88", "Walpay", "WesternUnion", "Wirecard", "WorldlineAtosFrankfurt", "Worldpay", "XPay", "Zimpler", "Zotapay"

  - `invoices.transactions.customFields` (object)
    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](https://www.rebilly.com/catalog/all/custom-fields).

  - `invoices.transactions.processedTime` (string)
    Date and time when the transaction is processed.

  - `invoices.transactions.createdTime` (string)
    Date and time when the resource is created.
This value is set automatically when the resource is created.

  - `invoices.transactions.updatedTime` (string)
    Date and time when the resource is updated.
This value is set automatically when the resource is updated.

  - `invoices.transactions.gatewayAccountId` (string,null)
    ID of the gateway account that processed the transaction.
    Example: "gw_acc_0YVCXMF26DDNKAERE5NW727S34"

  - `invoices.transactions.gatewayTransactionId` (string,null)
    ID of the gateway transaction.
    Example: "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"

  - `invoices.transactions.gateway` (object)
    Related gateway information.

  - `invoices.transactions.gateway.response` (object)
    Gateway response.

  - `invoices.transactions.gateway.response.code` (string,null)
    Gateway response code.

  - `invoices.transactions.gateway.response.message` (string,null)
    Gateway response message.

  - `invoices.transactions.gateway.response.type` (string,null)
    Gateway response type.

  - `invoices.transactions.gateway.response.originalCode` (string,null)
    Raw, unmapped gateway response code.

  - `invoices.transactions.gateway.response.originalMessage` (string,null)
    Raw, unmapped gateway response message.

  - `invoices.transactions.gateway.avsResponse` (object)
    Gateway Address Verification System (AVS) response.

  - `invoices.transactions.gateway.avsResponse.code` (string,null)
    Response code.

  - `invoices.transactions.gateway.avsResponse.message` (string,null)
    Response message.

  - `invoices.transactions.gateway.avsResponse.originalCode` (string,null)
    Raw response code.

  - `invoices.transactions.gateway.avsResponse.originalMessage` (string,null)
    Raw response message.

  - `invoices.transactions.gateway.cvvResponse` (object)
    Gateway Card Verification Value (CVV) response.

  - `invoices.transactions.gateway.cvvResponse.code` (string,null)
    Response code.

  - `invoices.transactions.gateway.cvvResponse.message` (string,null)
    Response message.

  - `invoices.transactions.gateway.cvvResponse.originalCode` (string,null)
    Raw response code.

  - `invoices.transactions.gateway.cvvResponse.originalMessage` (string,null)
    Raw response message.

  - `invoices.transactions.acquirerName` (string,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", "Aera", "Alipay", "AIB", "Aircash", "Airpay", "AmazonPay", "ApcoPay", "AsiaPaymentGateway", "AstroPay Card", "Awepay", "Ipay Options", "B+S", "Bambora", "BitPay", "Bank of America", "Bank of Moscow", "Bank of Rebilly", "Bank One", "BankSEND", "BMO Harris Bank", "Borgun", "BraintreePayments", "Buckaroo", "BVNK", "Cardknox", "CASHlib", "Cashterminal", "CashToCode", "Catalunya Caixa", "CCAvenue", "Chase", "CheckoutCom", "Chillstock", "ChinaUnionPay", "CIM", "Circle", "Citadel", "Clearhaus", "Cleo", "CODVoucher", "Coinbase", "CoinGate", "CoinPayments", "Conekta", "Coppr", "Credorax", "Cryptonator", "CyberSource", "Dimoco", "dLocal", "Dragonphoenix", "Dropayment", "EasyPayDirect", "EBANX", "ecoPayz", "EcorePay", "Elavon", "EMS", "ePay", "EPG", "Euteller", "Ezeebill", "eZeeWallet", "ezyEFT", "Fifth Third Bank", "Finrax", "First Data Buypass", "First Data Nashville", "First Data North", "First Data Omaha", "FinTecSystems", "Flexepin", "Forte", "FundSend", "gate2way", "Gigadat", "Global East", "Gooney", "Gpaysafe", "Heartland", "HiPay", "HSBC", "iCashOne", "iCanPay", "ICEPAY", "iCheque", "Ilixium", "Ingenico", "INOVAPAY", "Intuit", "Isx", "Jeton", "JPMOrbital", "Khelocard", "Klarna", "Konnektive", "Kushki", "Limepay", "Loonio", "loonie", "LPG", "Masapay", "MaxiCash", "MercadoPago", "Merrick", "Mission Valley Bank", "MiFinity", "MobilePay", "Moneris", "Monolo", "MonRem", "MuchBetter", "MuchBetterGateway", "MyFatoorah", "NATWEST", "Neosurf", "Netbanking", "Neteller", "NinjaWallet", "NMI", "NordikCoin", "NOWPayments", "NuaPay", "Nuvei", "OchaPay", "OmniMatrix", "Onlineueberweisen", "OnRamp", "Orbital", "Other", "Panamerican", "Panda Bank", "Paramount", "ParamountCommerce", "ParamountEft", "ParamountInterac", "Pay4fun", "Paybilt", "PayCash", "PayClub", "PayEcards", "PaymentAsia", "PaymenTechnologies", "PaymentsOS", "Paymero", "Paynetics", "PayPal", "Payper", "Payr", "PayRedeem", "PayRetailers", "PayTabs", "PayU", "PayULatam", "Payvision", "PharosPayments", "Piastrix", "Pin4Pay", "Peoples Trust Company", "PostFinance", "PPRO", "Privatbank", "Prosa", "PSiGate", "QQPay", "Rapyd", "RBC", "RBS WorldPay", "RealTime", "Rotessa", "Safecharge", "SaltarPay", "SecureTrading", "SecurionPay", "Skrill", "SmartInvoice", "SMSVoucher", "Sofort", "SparkPay", "State Bank of Mauritius", "STPMexico", "Stripe", "Tabby", "TBI", "Telr", "TestProcessor", "ToditoCash", "Triple000", "Truevo", "Trustly", "TrustPay", "TrustsPay", "TSYS", "TWINT", "Txn", "UPayCard", "Vantiv", "VCreditos", "VegaWallet", "VoicePay", "Wallet88", "WeChat Pay", "Wells Fargo", "Wing Hang Bank", "Wirecard", "WorldPay", "XPay", "Zimpler", "Zotapay"

  - `invoices.transactions.velocity` (integer)
    Number of transactions by the same customer in the past 24 hours.

  - `invoices.transactions.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.

  - `invoices.transactions.referenceData` (object,null)
    Transaction reference data.
    Example: {"gatewayTransactionId":"GAT123"}

  - `invoices.transactions.bin` (string,null)
    Payment card Bank Identification Number (BIN).

  - `invoices.transactions.paymentInstrument` (object) — one of:
    - Vaulted payment instrument:
      - `method` (string, required)
        Payment method supported vault.
For more information, see [Payment instrument](https://www.rebilly.com/catalog/all/payment-instruments).
        Enum: same as `method` in "Vaulted payment instrument" (3 values)
      - `paymentInstrumentId` (string, required)
        ID of the payment instrument.
        Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
    - Alternative instrument:
      - `method` (string, required)
        Payment method.
        Enum: same as `method` in "Alternative instrument" (198 values)
      - `paymentInstrumentId` (string)
        ID of the payment instrument.
        Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
      - `reference` (string,null)
        Reference data.
This field is available only for the bank-transfer payment method.
    - Cash:
      - `method` (string, required)
        Enum: same as `method` in "Cash" (1 values)
      - `receivedBy` (string)
        Individual or entity that received the payment.
    - Check:
      - `method` (string, required)
        Enum: same as `method` in "Check" (1 values)
      - `reference` (string)
        Reference data.

  - `invoices.transactions.hasDcc` (boolean)
    Specifies if Dynamic Currency Conversion (DCC) applies to the transaction.

  - `invoices.transactions.dcc` (object,null)
    Detailed Dynamic currency conversion (DCC).
If DCC is not applied to the transaction, this value is null.

  - `invoices.transactions.dcc.base` (object)
    Initial amount and currency to convert from.

  - `invoices.transactions.dcc.base.amount` (number, required)

  - `invoices.transactions.dcc.base.currency` (string, required)
    Currency code in ISO 4217 format.

  - `invoices.transactions.dcc.quote` (object)
    Suggested amount and currency to convert to.

  - `invoices.transactions.dcc.usdMarkup` (number)
    Markup amount converted to USD.

  - `invoices.transactions.dcc.outcome` (string)
    Dynamic currency conversion outcome.
    Enum: "unprocessed", "rejected", "selected"

  - `invoices.transactions.dcc.isForceDcc` (boolean)
    Specifies if Dynamic Currency Conversion (DCC) is forced for the transaction.

  - `invoices.transactions.riskScore` (integer)
    Risk score for the transaction.

  - `invoices.transactions.riskMetadata` (any)
    - `ipAddress` (string,null)
      Customer's IP address.
      Example: "93.92.91.90"
    - `fingerprint` (string,null)
      Customer's device fingerprint.
A device fingerprint is a unique token that is used to identify the customer.
The device fingerprint is generated based on device attributes, such as: hardware,
software, IP address, language, browser, and more.
      Example: "pIUt3xbgX3l9g3YDiLbx"
    - `httpHeaders` (any)
    - `browserData` (object,null)
      Browser data used for 3D Secure and risk scoring.
    - `browserData.colorDepth` (integer, required)
      Browser color depth in bits per pixel.
This value is obtained using the screen.colorDepth property.
      Example: 24
    - `browserData.isJavaEnabled` (boolean, required)
      Specifies if Java is enabled in a browser.
This value is obtained from the navigator.javaEnabled property.
    - `browserData.language` (string, required)
      Browser language settings.
This value is obtained from the navigator.language property.
      Example: "en-US"
    - `browserData.screenWidth` (integer, required)
      Width of the browser screen.
This value is obtained from the screen.width property.
      Example: 1920
    - `browserData.screenHeight` (integer, required)
      Height of the browser screen.
This value is obtained from the screen.height property.
      Example: 1080
    - `browserData.timeZoneOffset` (integer, required)
      Browser time zone offset in minutes from UTC.
A positive offset indicates that the local time is behind UTC.
A negative offset indicates that the local time is ahead of UTC.
You can find this value using the (new Date()).getTimezoneOffset() property.
      Example: 300
    - `browserData.isAdBlockEnabled` (boolean)
      Specifies if the usage of ad block has been detected in the browser.
    - `extraData` (object,null)
      Third-party data used for risk scoring.
    - `extraData.kountFraudSessionId` (string)
      Alpha-numeric fraudSessionId as provided by the Kount SDK.
      Example: "abcdefg12345abababab123456789012"
    - `extraData.payPalMerchantSessionId` (string)
      PayPal MerchantSessionID as generated by the PayPal Fraudnet SDK.
      Example: "dd65ratxc5qv15iph3vyoq7l6davuowa"
    - `extraData.threatMetrixSessionId` (string)
      Temporary identifier that is unique to the visitor session and passed to ThreatMetrix.
      Example: "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"
    - `isProxy` (boolean)
      Specifies if the customer's IP address is related to a proxy.
    - `isVpn` (boolean)
      Specifies if the customer's IP address is related to a VPN.
    - `isTor` (boolean)
      Specifies if the customer's IP address is related to TOR.
    - `isHosting` (boolean)
      Specifies if the customer's IP address is related to hosting.
    - `hostingName` (string,null)
      Name of the data center or hosting provider, if available.
    - `isp` (string,null)
      Internet Service Provider (ISP) name, if available.
    - `country` (string,null)
      Country ISO Alpha-2 code of the specified IP address.
      Example: "US"
    - `region` (string,null)
      Region of the specified IP address.
      Example: "NY"
    - `city` (string,null)
      City of the specified IP address.
      Example: "New York"
    - `latitude` (number)
      Latitude of the specified IP address.
    - `longitude` (number,null)
      Longitude of the specified IP address.
    - `postalCode` (string,null)
      Postal code of the specified IP address.
    - `timeZone` (string,null)
      Time zone of the specified IP address.
      Example: "America/New_York"
    - `accuracyRadius` (integer,null)
      Accuracy radius of the specified IP address, in kilometers.
    - `distance` (integer,null)
      Distance between the customer's IP address and the billing address geolocation, in kilometers.
    - `hasMismatchedBillingAddressCountry` (boolean)
      Specifies if the customer's billing address country and geo-IP address are not the same.
    - `hasMismatchedBankCountry` (boolean)
      Specifies if the customer's bank country and geo-IP address are not the same.
    - `hasMismatchedTimeZone` (boolean)
      Specifies if the customer's browser time zone and the IP address associated time zone are not the same.
    - `hasMismatchedHolderName` (boolean)
      Specifies if the customer's billing address name and primary address name are not the same.
    - `hasFakeName` (boolean)
      Specifies if the holder name seems fake.
    - `isHighRiskCountry` (boolean)
      Specifies if the geo-IP country, or the customer's billing country, is considered a high risk country.
    - `paymentInstrumentVelocity` (integer)
      Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours.
    - `declinedPaymentInstrumentVelocity` (integer)
      Number of declined transactions for this payment instrument fingerprint in the last 24 hours.
    - `deviceVelocity` (integer)
      Number of transactions for this device, based on fingerprint, in the last 24 hours.
    - `ipVelocity` (integer)
      Number of transactions for this IP address in the last 24 hours.
    - `emailVelocity` (integer)
      Number of transactions for this email address in the last 24 hours.
    - `billingAddressVelocity` (integer)
      Number of transactions for this billing address in the last 24 hours.
    - `paymentInstrumentApprovedTransactionCount` (integer)
      Number of approved transactions for this payment instrument.
    - `score` (integer)
      Computed risk score based on IP risk data,
such as: isVpn, isTor, and isProxy.

  - `invoices.transactions.notificationUrl` (string,null)
    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 interpret this notification as a confirmation,
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}.
These placeholders are replaced the with the transaction ID and result accordingly.

  - `invoices.transactions.isDisputed` (boolean)
    Specifies if a transaction is disputed.

  - `invoices.transactions.disputeTime` (string,null)
    Date and time when the dispute is created.
If the transaction is not disputed, this value is null.

  - `invoices.transactions.disputeStatus` (string,null)
    Status of the dispute.
    Enum: null, "response-needed", "under-review", "forfeited", "won", "lost", "unknown"

  - `invoices.transactions.isReconciled` (boolean)
    Specifies if the transaction is verified with gateway batch data.

  - `invoices.transactions.isProcessedOutside` (boolean)
    Specifies if the transaction is processed outside of Rebilly.

  - `invoices.transactions.isMerchantInitiated` (boolean)
    Specifies if the transaction is initiated by the merchant.

  - `invoices.transactions.hadDiscrepancy` (boolean)
    Specifies if the transaction is updated due to a discrepancy with its source of truth.

  - `invoices.transactions.arn` (string,null)
    Acquirer reference number.
    Example: "74836950144358910018150"

  - `invoices.transactions.reportAmount` (number)
    Transaction amount converted to the report currency of the organization.

  - `invoices.transactions.reportCurrency` (string)
    Currency code in ISO 4217 format.

  - `invoices.transactions.settlementTime` (string,null)
    Date and time when the transaction is settled by the banking institution.

  - `invoices.transactions.discrepancyTime` (string,null)
    Date and time of the most recent discrepancy on the transaction.

  - `invoices.transactions.limits` (object,null)
    Transaction amount limit information.

  - `invoices.transactions.limits.amount` (number)
    Limit amount.
    Example: 275.35

  - `invoices.transactions.limits.currency` (string)
    Currency code in ISO 4217 format.

  - `invoices.transactions.limits.resetTime` (string,null)
    Date and time in which the limit amount resets.
This value may be used for user interfaces.

  - `invoices.transactions.organizationId` (string)
    Unique organization identifier.
An organization is an entity that represents a company.
For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "org_0YVDM8RC7GDADADSBSMW124JA8"

  - `invoices.transactions.depositRequestId` (string,null)
    ID of the deposit request if applicable.
The created transaction is based on the properties of this deposit request.
    Example: "dep_req_0YVJ65BSGYC3EAT58SEX8KY6J7"

  - `invoices.transactions.transferId` (string,null)
    ID of the ledger transfer if applicable.
The transaction is linked to this transfer when processed in the wallet ledger.
    Example: "tb_0YVDTQJ8YWDGQACV2N2N5SPWQ0"

  - `invoices.transactions.payoutRequestId` (string,null)
    ID of the payout request if applicable.
The created transaction is based on the properties of this payout request.
    Example: "pout_req_0YVDMDE2BMC6KBB5MX76RF6T80"

  - `invoices.transactions._links` (array)
    Related links.

  - `invoices.transactions._links.href` (string)
    Link URL.

  - `invoices.transactions._links.rel` (string)
    Type of link.
    Enum: "self", "attachments", "website", "customer", "gatewayAccount", "paymentCard", "parentTransaction", "leadSource", "approvalUrl", "refundUrl", "updateUrl", "disputes", "invoices", "queryUrl", "redirectUrl"

  - `invoices.transactions._embedded` (object)
    Embedded objects that are requested by the expand query parameter.

  - `invoices.transactions._embedded.parentTransaction` (object)

  - `invoices.transactions._embedded.childTransactions` (array)
    Most recent child transactions.

  - `invoices.transactions._embedded.gatewayAccount` (object)

  - `invoices.transactions._embedded.customer` (object)

  - `invoices.transactions._embedded.leadSource` (object)

  - `invoices.transactions._embedded.website` (object)

  - `invoices.transactions._embedded.invoices` (array)
    Most recent related invoices.

  - `invoices.transactions._embedded.organization` (object)

  - `invoices.transactions._embedded.dispute` (object)

  - `invoices.transactions._embedded.paymentCard` (object)

  - `invoices.transactions._embedded.bankAccount` (object)

  - `invoices.transactions.method` (string)
    Payment method.

>Note: Use paymentInstrument.method instead.
    Enum: same as `method` in "Alternative instrument" (198 values)

  - `invoices.transactions.orderId` (string)
    Order ID of the transaction.
This ID must be unique within a 24 hour period.

> Note: Use the requestId field instead.

  - `invoices.retryInstruction` (object,null)
    Invoice payment retry instruction.
This object specifies how to proceed if a payment related to the invoice fails.

  - `invoices.retryInstruction.attempts` (array, required)
    Describes the retry instruction.

  - `invoices.retryInstruction.attempts.scheduleInstruction` (object, required) — one of (discriminator: method):
    Specifies when the payment retry instruction is performed.
    - date-interval:
      - `method` (string, required)
        Enum: "date-interval"
      - `duration` (integer, required)
        Number of time units.
      - `unit` (any, required)
        Unit of time.
      - `anchor` (object) — one of (discriminator: method):
        Instruction for calculating the period anchor.
        - day-of-month:
          - `method` (string, required)
            Enum: "day-of-month"
          - `day` (integer, required)
            Day of the month in which the event occurs.
If the month has less days, the last day of the month is selected.
          - `time` (string)
            Extended ISO-8601 format of time.
        - day-of-week:
          - `method` (string, required)
            Enum: "day-of-week"
          - `day` (string, required)
            Day of the week when the event occurs.
            Enum: "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"
          - `week` (string, required)
            Enum: "next", "first-in-month", "last-in-month"
          - `time` (string)
            Extended ISO-8601 format of time.
    - day-of-month:
      - `method` (string, required)
        Enum: same as `method` in "day-of-month" (1 values)
      - `day` (integer, required)
        Day of the month in which the event occurs.
If the month has less days, the last day of the month is selected.
      - `time` (string)
        Extended ISO-8601 format of time.
    - day-of-week:
      - `method` (string, required)
        Enum: same as `method` in "day-of-week" (1 values)
      - `day` (string, required)
        Day of the week when the event occurs.
        Enum: same as `day` in "day-of-week" (7 values)
      - `week` (string, required)
        Enum: same as `week` in "day-of-week" (3 values)
      - `time` (string)
        Extended ISO-8601 format of time.
    - immediately:
      - `method` (string, required)
        Enum: "immediately"
    - intelligent:
      - `method` (string, required)
        Enum: "intelligent"
      - `duration` (integer, required)
        Latest point in time at which the event should occur.
The event occurs at a random time between the initial time and duration time.
      - `unit` (any, required)
        Unit of time.

  - `invoices.retryInstruction.attempts.amountAdjustmentInstruction` (object) — one of (discriminator: method):
    Specifies if the payment amount must be adjusted for the retry.
    - partial:
      - `method` (string, required)
        Enum: "partial"
      - `value` (number, required)
        Amount of the payment.
      - `type` (string, required)
        Payment amount type.
        Enum: "percent", "fixed"
      - `afterApprovalPolicy` (any) — one of (discriminator: method):
        After an approved payment retry for an adjusted amount, this field specifies whether to discount the remaining invoice amount.
        - none:
          - `method` (string, required)
            No payment amount adjustment.
            Enum: "none"
        - discount-amount-remaining:
          - `method` (string, required)
            Discount the remaining amount on the invoice.
            Enum: "discount-amount-remaining"
    - none:
      - `method` (string, required)
        Enum: same as `method` in "none" (1 values)

  - `invoices.retryInstruction.attempts.tryBackupInstruments` (boolean)
    Specifies whether to use backup payment instruments on an invoice payment retry.

  - `invoices.retryInstruction.afterAttemptPolicies` (array, required)
    Describes the action to take when a payment attempt concludes, and payment is not collected.
    Enum: "change-subscription-renewal-time"

  - `invoices.retryInstruction.afterRetryEndPolicies` (array, required)
    Describes the action to take when all scheduled payment retries, in a retry instruction, have concluded and payment is not collected.
    Enum: "abandon-invoice", "cancel-subscription"

  - `invoices.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.

  - `invoices.type` (string)
    Type of invoice.
    Enum: "initial", "renewal", "interim", "cancellation", "one-time", "refund", "charge", "one-time-sale"

  - `invoices.dueReminderTime` (string,null)
    Date and time when a past due reminder event is triggered.

  - `invoices.dueReminderNumber` (integer,null)
    Number of past due reminder events that have been triggered.

  - `invoices.organizationId` (string)
    Unique organization identifier.
An organization is an entity that represents a company.
For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
    Example: "org_0YVDM8RC7GDADADSBSMW124JA8"

  - `invoices.delinquencyTime` (string,null)
    Date and time when the related order is considered delinquent, and is canceled.
If this value is null, no delinquency time is configured.
If the dueTime of the order becomes greater than the delinquencyTime value,
the delinquencyTime value becomes equal to dueTime.

If an invoice is not related to an order, this field can only be null.

  - `invoices._links` (array)
    Related links.

  - `invoices._links.href` (string)
    Link URL.

  - `invoices._links.rel` (string)
    Type of link.
    Enum: "self", "website", "customer", "organization", "attachments", "leadSource", "transactionAllocations", "recalculateInvoice", "subscription"

  - `invoices._embedded` (object)
    Embedded objects that are requested by the expand query parameter.

  - `invoices._embedded.customer` (object)

  - `invoices._embedded.website` (object)

  - `invoices._embedded.organization` (object)

  - `invoices._embedded.leadSource` (object)

  - `invoices._embedded.shippingRate` (object)

  - `orders` (array) — one of (discriminator: orderType):
    List of returned orders.
    - subscription-order:
      - `id` (string)
        ID of the order.
        Example: "sub_01HRF27SATGE4Z6PBJE6PD8328"
      - `orderType` (string, required)
        Specifies the type of order.
An order may be a subscription or a one-time purchase.

> Note: The order type cannot be changed after creation.
        Enum: "subscription-order"
      - `customerId` (string, required)
        ID of the customer resource.
      - `renewalReminderTime` (string,null)
        Date and time when the renewal reminder event triggers.
      - `renewalReminderNumber` (integer,null)
        Number of triggered renewal reminder events.
      - `abandonReminderTime` (string,null)
        Date and time when the abandon order reminder event triggers.
      - `abandonReminderNumber` (integer,null)
        Number of abandon order reminder events that are triggered.
      - `organizationId` (string)
        Unique organization identifier.
An organization is an entity that represents a company.
For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
        Example: "org_0YVDM8RC7GDADADSBSMW124JA8"
      - `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.
      - `trial` (object)
        Details of the trial.
To use plan defaults, omit the trial key or set this value to null.
      - `trial.enabled` (boolean)
        Specifies if there is a trial for this subscription.
Plans without trial prices are free trials.
      - `trial.endTime` (string,null)
        Time and date when the trial ends.
If a trial is enabled on this subscription, a value must be provided.

If the specified trial end time is in the past, the current time is used.
      - `isTrialOnly` (boolean)
        Specifies if a subscription ends after a trial period.
If this value is true, recurring settings are ignored.
      - `trialConversionTime` (string,null)
        Date and time when the subscription had a trial conversion.
Trial conversion occurs when the first successful payment is made after a trial period.
      - `invoiceTimeShift` (object,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.
      - `invoiceTimeShift.issueTimeShift` (object)
        Calculation instruction of the billing time.

This is used in conjunction with the service period anchor to calculate
the time at which the invoice is issued. For more information, see
[Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
      - `invoiceTimeShift.issueTimeShift.chronology` (string, required)
        Sequential order of the billing time relative to the start of the service period.
        Enum: "before"
      - `invoiceTimeShift.issueTimeShift.duration` (integer, required)
        Amount of time by which to move the invoice issue time or date.
      - `invoiceTimeShift.issueTimeShift.unit` (any, required)
        Unit of time.
      - `invoiceTimeShift.dueTimeShift` (object)
        Calculation instruction of the invoice due time.

This is used in conjunction with the billing anchor to calculate when
an invoice is due for payment. For more information, see
[Service period anchor, billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).

The sequential order of due time shift is always after the due date.
      - `invoiceTimeShift.dueTimeShift.duration` (integer, required)
        Amount of time by which to move the invoice due time or date.
      - `invoiceTimeShift.dueTimeShift.unit` (any, required)
        Unit of time.
      - `recurringInterval` (object,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.
      - `recurringInterval.periodAnchorInstruction` (object,null) — one of (discriminator: method):
        Instruction for calculating the service period anchor.

The service period anchor is used, in conjunction with the subscription
start time, to calculate when the service period starts and ends.
        - day-of-month:
          - `method` (string, required)
            Enum: same as `method` in "day-of-month" (1 values)
          - `day` (integer, required)
            Day of the month in which the event occurs.
If the month has less days, the last day of the month is selected.
          - `time` (string)
            Extended ISO-8601 format of time.
        - day-of-week:
          - `method` (string, required)
            Enum: same as `method` in "day-of-week" (1 values)
          - `day` (string, required)
            Day of the week when the event occurs.
            Enum: same as `day` in "day-of-week" (7 values)
          - `week` (string, required)
            Enum: same as `week` in "day-of-week" (3 values)
          - `time` (string)
            Extended ISO-8601 format of time.
        - day-and-month-of-year:
          - `method` (string, required)
            Enum: "day-and-month-of-year"
          - `day` (integer, required)
            Day of the month in which the event occurs.
If the month has less days, the last day of the month is selected.
          - `month` (integer, required)
            Month of the year in which the event occurs.
          - `time` (string)
            Extended ISO-8601 format of time.
      - `autopay` (boolean)
        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,null)
        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.
      - `churnTime` (string,null)
        Date and time when the subscription is deactivated.
      - `renewalTime` (string,null)
        Date and time when the subscription renews.
      - `currentPeriodStart` (string)
        Date and time of the current service period start.
      - `currentPeriodEnd` (string)
        Date and time of the current service period end.
      - `rebillNumber` (integer,null)
        Current billing period number.
      - `mrr` (number)
        Monthly recurring revenue of the order.
        Example: 49.95
      - `paymentInstrumentId` (string,null)
        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.
        Example: "inst_0YVB8KPKNXCBR9EDX7JHSED75N"
      - `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"
      - `websiteId` (string, required)
        ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).

> Note: The ID of the website cannot be changed after creation.
        Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
      - `currency` (string)
        Currency of the order.
      - `initialInvoiceId` (string,null)
        ID of the initial invoice.
        Example: "in_0YVF9605RKC62BP14NE2R7V2XT"
      - `recentInvoiceId` (string,null)
        ID of the most recently issued invoice.
The invoice might not be paid yet.
        Example: "in_0YVF9605RKC62BP14NE2R7V2XT"
      - `items` (array, required)
        Details of items in the order.
      - `items.id` (string)
        ID of the order item.
      - `items.quantity` (integer)
        Number of product units in the specified plan.
      - `items.quantityFilled` (number)
        Number of filled product units.
        Example: 5.125
      - `items.plan` (any, required)
        - `id` (string, required)
          ID of the plan.
      - `items.usageLimits` (any)
        - `softLimit` (object)
          Defines thresholds for notification purposes.
For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
When the reported usage reaches 75%, 90%, and 100% of the configured limit a specific event is triggered.
To notify the customer, a webhook and notification can be configured for this event.
This field is useful for accounting and customer success purposes.
The usage of metered billing plans can still be reported if the soft limit is reached.
        - `softLimit.quantity` (integer)
          Usage limit quantity.
        - `softLimit.amount` (number)
          Usage limit amount in the currency of the order.
        - `hardLimit` (object)
          Defines a limit where the customer can no longer use the service.
Hard limits are used in addition to soft limits.
When a soft limit is reached,
a customer may receive a notification
but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
When the reported usage reaches the configured limit,
a specific event is triggered.
To notify the customer in the merchant system,
or block a service,
a webhook and notification can be configured for this event.
When the total usage reaches the hard limit quantity,
or amount values,
metered billing plan usages can no longer be reported.
        - `hardLimit.quantity` (integer)
          Usage limit quantity.
        - `hardLimit.amount` (number)
          Usage limit amount in the currency of the order.
        - `trialLimit` (any)
          Defines a usage cap during the trial period of a subscription.
This limit is enforced only while the subscription is in its trial phase.
When the reported usage reaches the configured trial limit, an event called 'trial-usage-limit-reached' is triggered.
To notify the customer or restrict access to the service, a webhook and notification can be configured for this event.
Once the trial limit is reached, additional usage cannot be reported unless the trial ends.
          Example: 20.725
      - `items.usageStatus` (any)
        - `isSoftLimitReached` (boolean)
          Specifies if the soft limit has been reached.
        - `isHardLimitReached` (boolean)
          Specifies if the hard limit has been reached.
        - `isTrialLimitReached` (boolean)
          Specifies if the trial limit has been reached.
      - `items.revision` (integer)
        Revision number that increments with each overriding change to this specific plan item.
      - `items.isModified` (boolean)
        Specifies if the plan information is modified for this subscription.
      - `items.isGrandfathered` (boolean)
        Specifies if the current plan revision number is greater than the plan item revision number.
      - `items.excludeFromMrr` (boolean)
        Specifies if this item should be excluded from monthly recurring revenue calculations.
      - `items._embedded` (object)
        Embedded objects that are requested by the expand query parameter.
      - `items._embedded.product` (object)
      - `items.planId` (string)
        ID of the plan.
        Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"
      - `deliveryAddress` (any)
        Delivery address of the order.
      - `billingAddress` (any)
        Billing address of the order.
      - `activationTime` (string,null)
        Date and time when the order is activated.
      - `voidTime` (string,null)
        Date and time when the order is voided.
      - `abandonTime` (string,null)
        Date and time when the pending order is automatically abandoned.
If this value is not passed during order creation,
a [pending order TTL](https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/pendingorderttl) setting is used to calculate the value.
      - `delinquencyPeriod` (string,null)
        Length of time, in ISO-8601 durations format,
which is added to the due time of the order when setting the delinquency time for all related invoices.
When the delinquency time of an invoice is reached, the order is automatically canceled.

{% admonition type="warning" %}
- If the delinquencyPeriod value is null, the order does not change state and remains active.
You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
- If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the delinquencyTime parameter using the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime).
{% /admonition %}

If this value is not passed during order creation,
an [order delinquency period](https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/orderdelinquencyperiod) setting is used to calculate the value.
        Example: "P7D"
      - `poNumber` (string,null)
        Purchase order number displayed on the issued invoices.
        Example: "PO123456"
      - `shipping` (object) — one of (discriminator: calculator):
        Shipping settings.
        - manual:
          - `amount` (number, required)
            Shipping amount.
          - `calculator` (string, required)
            Shipping calculator.
            Enum: same as `calculator` in "manual" (1 values)
        - rebilly:
          - `calculator` (string, required)
            Shipping calculator.
            Enum: same as `calculator` in "rebilly" (1 values)
          - `rateId` (string,null)
            ID of the shipping rate.
If this value is not set,
the cheapest applicable shipping rate is used.
            Example: "shipping-123-456"
          - `amount` (number)
            Shipping amount which is calculated from [Shipping rates](https://www.rebilly.com/catalog/all/shipping-rates).
      - `notes` (string)
        Notes for the customer displayed on the order invoice.
      - `canceledTime` (string,null)
        Date and time when a subscription is canceled.
      - `canceledBy` (string,null)
        Specifies who initiated the cancellation.
        Enum: "merchant", "customer", "rebilly", null
      - `cancelCategory` (string,null)
        Category of the cancellation.
        Enum: "billing-failure", "delinquency", "did-not-use", "did-not-want", "missing-features", "bugs-or-problems", "do-not-remember", "risk-warning", "contract-expired", "too-expensive", "never-started", "switched-plan", "organization-deactivated", "other", null
      - `cancelDescription` (string,null)
        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.
      - `riskMetadata` (any)
        Risk metadata.
If this value is null, this field uses risk metadata that is captured when creating the payment token.
        - `ipAddress` (string,null)
          Customer's IP address.
          Example: "93.92.91.90"
        - `fingerprint` (string,null)
          Customer's device fingerprint.
A device fingerprint is a unique token that is used to identify the customer.
The device fingerprint is generated based on device attributes, such as: hardware,
software, IP address, language, browser, and more.
          Example: "pIUt3xbgX3l9g3YDiLbx"
        - `httpHeaders` (any)
        - `browserData` (object,null)
          Browser data used for 3D Secure and risk scoring.
        - `browserData.colorDepth` (integer, required)
          Browser color depth in bits per pixel.
This value is obtained using the screen.colorDepth property.
          Example: 24
        - `browserData.isJavaEnabled` (boolean, required)
          Specifies if Java is enabled in a browser.
This value is obtained from the navigator.javaEnabled property.
        - `browserData.language` (string, required)
          Browser language settings.
This value is obtained from the navigator.language property.
          Example: "en-US"
        - `browserData.screenWidth` (integer, required)
          Width of the browser screen.
This value is obtained from the screen.width property.
          Example: 1920
        - `browserData.screenHeight` (integer, required)
          Height of the browser screen.
This value is obtained from the screen.height property.
          Example: 1080
        - `browserData.timeZoneOffset` (integer, required)
          Browser time zone offset in minutes from UTC.
A positive offset indicates that the local time is behind UTC.
A negative offset indicates that the local time is ahead of UTC.
You can find this value using the (new Date()).getTimezoneOffset() property.
          Example: 300
        - `browserData.isAdBlockEnabled` (boolean)
          Specifies if the usage of ad block has been detected in the browser.
        - `extraData` (object,null)
          Third-party data used for risk scoring.
        - `extraData.kountFraudSessionId` (string)
          Alpha-numeric fraudSessionId as provided by the Kount SDK.
          Example: "abcdefg12345abababab123456789012"
        - `extraData.payPalMerchantSessionId` (string)
          PayPal MerchantSessionID as generated by the PayPal Fraudnet SDK.
          Example: "dd65ratxc5qv15iph3vyoq7l6davuowa"
        - `extraData.threatMetrixSessionId` (string)
          Temporary identifier that is unique to the visitor session and passed to ThreatMetrix.
          Example: "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"
        - `isProxy` (boolean)
          Specifies if the customer's IP address is related to a proxy.
        - `isVpn` (boolean)
          Specifies if the customer's IP address is related to a VPN.
        - `isTor` (boolean)
          Specifies if the customer's IP address is related to TOR.
        - `isHosting` (boolean)
          Specifies if the customer's IP address is related to hosting.
        - `hostingName` (string,null)
          Name of the data center or hosting provider, if available.
        - `isp` (string,null)
          Internet Service Provider (ISP) name, if available.
        - `country` (string,null)
          Country ISO Alpha-2 code of the specified IP address.
          Example: "US"
        - `region` (string,null)
          Region of the specified IP address.
          Example: "NY"
        - `city` (string,null)
          City of the specified IP address.
          Example: "New York"
        - `latitude` (number)
          Latitude of the specified IP address.
        - `longitude` (number,null)
          Longitude of the specified IP address.
        - `postalCode` (string,null)
          Postal code of the specified IP address.
        - `timeZone` (string,null)
          Time zone of the specified IP address.
          Example: "America/New_York"
        - `accuracyRadius` (integer,null)
          Accuracy radius of the specified IP address, in kilometers.
        - `distance` (integer,null)
          Distance between the customer's IP address and the billing address geolocation, in kilometers.
        - `hasMismatchedBillingAddressCountry` (boolean)
          Specifies if the customer's billing address country and geo-IP address are not the same.
        - `hasMismatchedBankCountry` (boolean)
          Specifies if the customer's bank country and geo-IP address are not the same.
        - `hasMismatchedTimeZone` (boolean)
          Specifies if the customer's browser time zone and the IP address associated time zone are not the same.
        - `hasMismatchedHolderName` (boolean)
          Specifies if the customer's billing address name and primary address name are not the same.
        - `hasFakeName` (boolean)
          Specifies if the holder name seems fake.
        - `isHighRiskCountry` (boolean)
          Specifies if the geo-IP country, or the customer's billing country, is considered a high risk country.
        - `paymentInstrumentVelocity` (integer)
          Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours.
        - `declinedPaymentInstrumentVelocity` (integer)
          Number of declined transactions for this payment instrument fingerprint in the last 24 hours.
        - `deviceVelocity` (integer)
          Number of transactions for this device, based on fingerprint, in the last 24 hours.
        - `ipVelocity` (integer)
          Number of transactions for this IP address in the last 24 hours.
        - `emailVelocity` (integer)
          Number of transactions for this email address in the last 24 hours.
        - `billingAddressVelocity` (integer)
          Number of transactions for this billing address in the last 24 hours.
        - `paymentInstrumentApprovedTransactionCount` (integer)
          Number of approved transactions for this payment instrument.
        - `score` (integer)
          Computed risk score based on IP risk data,
such as: isVpn, isTor, and isProxy.
      - `billingPortalToken` (string,null)
        Customer JWT to access a billing portal.
This field is presented only if a billing portal exists.
This is an experimental field and can be changed or removed in the future.
      - `customFields` (object)
        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](https://www.rebilly.com/catalog/all/custom-fields).
      - `createdTime` (string)
        Date and time when the resource is created.
This value is set automatically when the resource is created.
      - `updatedTime` (string)
        Date and time when the resource is updated.
This value is set automatically when the resource is updated.
      - `_links` (array)
        Related links.
      - `_links.href` (string)
        Link URL.
      - `_links.rel` (string)
        Type of link.
        Enum: "self", "website", "customer", "initialInvoice", "recentInvoice", "approvalUrl", "attachments"
      - `_embedded` (object)
        Embedded objects that are requested by the expand query parameter.
      - `_embedded.recentInvoice` (object)
      - `_embedded.initialInvoice` (object)
      - `_embedded.customer` (object)
      - `_embedded.website` (object)
      - `_embedded.leadSource` (object)
      - `_embedded.shippingRate` (object)
      - `_embedded.paymentInstrument` (object)
      - `_embedded.upcomingInvoice` (object)
      - `lineItems` (array)
        Subscription line items which queue until the next renewal, or interim, invoice is issued for the subscription.
      - `lineItems.type` (string)
        Type of invoice line item.
        Enum: same as `invoices.items.type` (2 values)
      - `lineItems.description` (string)
        Description of the line item.
      - `lineItems.unitPriceAmount` (number)
        Unit price of the line item.
        Example: 49.95
      - `lineItems.unitPriceCurrency` (string)
        Currency code in ISO 4217 format.
      - `lineItems.quantity` (integer)
        Quantity of the line item.
        Example: 1
      - `lineItems.periodStartTime` (string)
        Date and time when the service period begins for this item.
      - `lineItems.periodEndTime` (string)
        Date and time when the service period ends for this item.
      - `lineItems.createdTime` (string)
        Date and time when the resource is created.
This value is set automatically when the resource is created.
      - `lineItems.updatedTime` (string)
        Date and time when the resource is updated.
This value is set automatically when the resource is updated.
      - `lineItemSubtotal` (object)
        Subtotal of line items in this subscription (signed value).
If credits exceed debits, this value is a negative number.
      - `lineItemSubtotal.currency` (string)
        Currency code in ISO 4217 format.
      - `lineItemSubtotal.amount` (number)
        Amount of the subtotal.
        Example: 49.95
    - one-time-order:
      - `id` (string)
        ID of the one-time sale.
        Example: "ots_01HRF27SATGE4Z6PBJE6PD8328"
      - `orderType` (string, required)
        Specifies the type of order.
An order may be a subscription or a one-time purchase.
        Enum: "one-time-order"
      - `customerId` (string, required)
        ID of the customer resource.
      - `status` (string)
        Status of the one-time order.
        Enum: "pending", "abandoned", "completed", "canceled"
      - `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: same as `billingStatus` in "subscription-order" (10 values)
      - `websiteId` (string, required)
        ID of the website.
A website is where an organization obtains a customer.
For more information, see [Obtain an organization ID and website ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
        Example: "web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
      - `currency` (string)
        Currency of the order.
      - `initialInvoiceId` (string,null)
        ID of the initial invoice (null for one-time orders).
        Example: "in_0YVF9605RKC62BP14NE2R7V2XT"
      - `recentInvoiceId` (string,null)
        ID of the most recently issued invoice.
The invoice might not be paid yet.
        Example: "in_0YVF9605RKC62BP14NE2R7V2XT"
      - `items` (array, required)
        Details of items in the order.
      - `items.id` (string)
        ID of the order item.
      - `items.quantity` (integer)
        Number of product units in the specified plan.
      - `items.quantityFilled` (number)
        Number of filled product units.
        Example: 5.125
      - `items.plan` (any, required)
        - `id` (string, required)
          ID of the plan.
      - `items.usageLimits` (any)
        - `softLimit` (object)
          Defines thresholds for notification purposes.
For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
When the reported usage reaches 75%, 90%, and 100% of the configured limit a specific event is triggered.
To notify the customer, a webhook and notification can be configured for this event.
This field is useful for accounting and customer success purposes.
The usage of metered billing plans can still be reported if the soft limit is reached.
        - `softLimit.quantity` (integer)
          Usage limit quantity.
        - `softLimit.amount` (number)
          Usage limit amount in the currency of the order.
        - `hardLimit` (object)
          Defines a limit where the customer can no longer use the service.
Hard limits are used in addition to soft limits.
When a soft limit is reached,
a customer may receive a notification
but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
When the reported usage reaches the configured limit,
a specific event is triggered.
To notify the customer in the merchant system,
or block a service,
a webhook and notification can be configured for this event.
When the total usage reaches the hard limit quantity,
or amount values,
metered billing plan usages can no longer be reported.
        - `hardLimit.quantity` (integer)
          Usage limit quantity.
        - `hardLimit.amount` (number)
          Usage limit amount in the currency of the order.
        - `trialLimit` (any)
          Defines a usage cap during the trial period of a subscription.
This limit is enforced only while the subscription is in its trial phase.
When the reported usage reaches the configured trial limit, an event called 'trial-usage-limit-reached' is triggered.
To notify the customer or restrict access to the service, a webhook and notification can be configured for this event.
Once the trial limit is reached, additional usage cannot be reported unless the trial ends.
          Example: 20.725
      - `items.usageStatus` (any)
        - `isSoftLimitReached` (boolean)
          Specifies if the soft limit has been reached.
        - `isHardLimitReached` (boolean)
          Specifies if the hard limit has been reached.
        - `isTrialLimitReached` (boolean)
          Specifies if the trial limit has been reached.
      - `items.revision` (integer)
        Revision number that increments with each overriding change to this specific plan item.
      - `items.isModified` (boolean)
        Specifies if the plan information is modified for this subscription.
      - `items.isGrandfathered` (boolean)
        Specifies if the current plan revision number is greater than the plan item revision number.
      - `items.excludeFromMrr` (boolean)
        Specifies if this item should be excluded from monthly recurring revenue calculations.
      - `items._embedded` (object)
        Embedded objects that are requested by the expand query parameter.
      - `items._embedded.product` (object)
      - `items.planId` (string)
        ID of the plan.
        Example: "plan_0YV7DENSVGDBW9S71XZNNYYQ0X"
      - `deliveryAddress` (any)
        Delivery address of the order.
      - `billingAddress` (any)
        Billing address of the order.
      - `activationTime` (string,null)
        Date and time when the order is activated.
      - `voidTime` (string,null)
        Date and time when the order is voided.
      - `abandonTime` (string,null)
        Date and time when the pending order is automatically abandoned.
If this value is not passed during order creation,
a [pending order TTL](https://www.rebilly.com/catalog/all/organizations/patchorganization#organizations/patchorganization/t=request&path=settings/billing/pendingorderttl) setting is used to calculate the value.
      - `poNumber` (string,null)
        Purchase order number displayed on the issued invoices.
        Example: "PO123456"
      - `shipping` (object) — one of (discriminator: calculator):
        Shipping settings.
        - manual:
          - `amount` (number, required)
            Shipping amount.
          - `calculator` (string, required)
            Shipping calculator.
            Enum: same as `calculator` in "manual" (1 values)
        - rebilly:
          - `calculator` (string, required)
            Shipping calculator.
            Enum: same as `calculator` in "rebilly" (1 values)
          - `rateId` (string,null)
            ID of the shipping rate.
If this value is not set,
the cheapest applicable shipping rate is used.
            Example: "shipping-123-456"
          - `amount` (number)
            Shipping amount which is calculated from [Shipping rates](https://www.rebilly.com/catalog/all/shipping-rates).
      - `notes` (string)
        Notes for the customer displayed on the order invoice.
      - `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.
      - `riskMetadata` (any)
        Risk metadata.
If this value is null, this field uses risk metadata that is captured when creating the payment token.
        - `ipAddress` (string,null)
          Customer's IP address.
          Example: "93.92.91.90"
        - `fingerprint` (string,null)
          Customer's device fingerprint.
A device fingerprint is a unique token that is used to identify the customer.
The device fingerprint is generated based on device attributes, such as: hardware,
software, IP address, language, browser, and more.
          Example: "pIUt3xbgX3l9g3YDiLbx"
        - `httpHeaders` (any)
        - `browserData` (object,null)
          Browser data used for 3D Secure and risk scoring.
        - `browserData.colorDepth` (integer, required)
          Browser color depth in bits per pixel.
This value is obtained using the screen.colorDepth property.
          Example: 24
        - `browserData.isJavaEnabled` (boolean, required)
          Specifies if Java is enabled in a browser.
This value is obtained from the navigator.javaEnabled property.
        - `browserData.language` (string, required)
          Browser language settings.
This value is obtained from the navigator.language property.
          Example: "en-US"
        - `browserData.screenWidth` (integer, required)
          Width of the browser screen.
This value is obtained from the screen.width property.
          Example: 1920
        - `browserData.screenHeight` (integer, required)
          Height of the browser screen.
This value is obtained from the screen.height property.
          Example: 1080
        - `browserData.timeZoneOffset` (integer, required)
          Browser time zone offset in minutes from UTC.
A positive offset indicates that the local time is behind UTC.
A negative offset indicates that the local time is ahead of UTC.
You can find this value using the (new Date()).getTimezoneOffset() property.
          Example: 300
        - `browserData.isAdBlockEnabled` (boolean)
          Specifies if the usage of ad block has been detected in the browser.
        - `extraData` (object,null)
          Third-party data used for risk scoring.
        - `extraData.kountFraudSessionId` (string)
          Alpha-numeric fraudSessionId as provided by the Kount SDK.
          Example: "abcdefg12345abababab123456789012"
        - `extraData.payPalMerchantSessionId` (string)
          PayPal MerchantSessionID as generated by the PayPal Fraudnet SDK.
          Example: "dd65ratxc5qv15iph3vyoq7l6davuowa"
        - `extraData.threatMetrixSessionId` (string)
          Temporary identifier that is unique to the visitor session and passed to ThreatMetrix.
          Example: "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"
        - `isProxy` (boolean)
          Specifies if the customer's IP address is related to a proxy.
        - `isVpn` (boolean)
          Specifies if the customer's IP address is related to a VPN.
        - `isTor` (boolean)
          Specifies if the customer's IP address is related to TOR.
        - `isHosting` (boolean)
          Specifies if the customer's IP address is related to hosting.
        - `hostingName` (string,null)
          Name of the data center or hosting provider, if available.
        - `isp` (string,null)
          Internet Service Provider (ISP) name, if available.
        - `country` (string,null)
          Country ISO Alpha-2 code of the specified IP address.
          Example: "US"
        - `region` (string,null)
          Region of the specified IP address.
          Example: "NY"
        - `city` (string,null)
          City of the specified IP address.
          Example: "New York"
        - `latitude` (number)
          Latitude of the specified IP address.
        - `longitude` (number,null)
          Longitude of the specified IP address.
        - `postalCode` (string,null)
          Postal code of the specified IP address.
        - `timeZone` (string,null)
          Time zone of the specified IP address.
          Example: "America/New_York"
        - `accuracyRadius` (integer,null)
          Accuracy radius of the specified IP address, in kilometers.
        - `distance` (integer,null)
          Distance between the customer's IP address and the billing address geolocation, in kilometers.
        - `hasMismatchedBillingAddressCountry` (boolean)
          Specifies if the customer's billing address country and geo-IP address are not the same.
        - `hasMismatchedBankCountry` (boolean)
          Specifies if the customer's bank country and geo-IP address are not the same.
        - `hasMismatchedTimeZone` (boolean)
          Specifies if the customer's browser time zone and the IP address associated time zone are not the same.
        - `hasMismatchedHolderName` (boolean)
          Specifies if the customer's billing address name and primary address name are not the same.
        - `hasFakeName` (boolean)
          Specifies if the holder name seems fake.
        - `isHighRiskCountry` (boolean)
          Specifies if the geo-IP country, or the customer's billing country, is considered a high risk country.
        - `paymentInstrumentVelocity` (integer)
          Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours.
        - `declinedPaymentInstrumentVelocity` (integer)
          Number of declined transactions for this payment instrument fingerprint in the last 24 hours.
        - `deviceVelocity` (integer)
          Number of transactions for this device, based on fingerprint, in the last 24 hours.
        - `ipVelocity` (integer)
          Number of transactions for this IP address in the last 24 hours.
        - `emailVelocity` (integer)
          Number of transactions for this email address in the last 24 hours.
        - `billingAddressVelocity` (integer)
          Number of transactions for this billing address in the last 24 hours.
        - `paymentInstrumentApprovedTransactionCount` (integer)
          Number of approved transactions for this payment instrument.
        - `score` (integer)
          Computed risk score based on IP risk data,
such as: isVpn, isTor, and isProxy.
      - `customFields` (object)
        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](https://www.rebilly.com/catalog/all/custom-fields).
      - `createdTime` (string)
        Date and time when the resource is created.
This value is set automatically when the resource is created.
      - `updatedTime` (string)
        Date and time when the resource is updated.
This value is set automatically when the resource is updated.
      - `_links` (array)
        Related links.
      - `_links.href` (string)
        Link URL.
      - `_links.rel` (string)
        Type of link.
        Enum: same as `_links.rel` in "subscription-order" (7 values)
      - `_embedded` (object)
        Embedded objects that are requested by the expand query parameter.
      - `_embedded.recentInvoice` (object)
      - `_embedded.customer` (object)
      - `_embedded.website` (object)
      - `_embedded.leadSource` (object)
      - `_embedded.shippingRate` (object)
      - `_embedded.paymentInstrument` (object)
      - `organizationId` (string)
        Unique organization identifier.
An organization is an entity that represents a company.
For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
        Example: "org_0YVDM8RC7GDADADSBSMW124JA8"

  - `transactions` (array)
    List of returned transactions.

  - `searched` (array)
    Names of searched resources.
Includes all searched resources.

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.