On this page
No Headings
The invoice details which includes all information of the invoice like items, billing information.
objectidstring^[\s\S]*$The ID of the invoice.
parent_idstring^[\s\S]*$The parent ID to an invoice that defines the group invoice to which the invoice is related.
statusobject"DRAFT", "SENT", "SCHEDULED", "PAID", "MARKED_AS_PAID", "CANCELLED", "REFUNDED", "PARTIALLY_PAID", "PARTIALLY_REFUNDED", "MARKED_AS_REFUNDED", "UNPAID", "PAYMENT_PENDING", "AUTO_CANCELLED", "PAID_EXTERNAL", "REFUNDED_EXTERNAL", "SHARED"The status of the invoice.
detailrequiredobjectThe details of the invoice. Includes invoice number, date, payment terms, and audit metadata.
invoice_numberstring^[\S\s]*$The invoice number. If omitted, an auto-incremented number from the last number is used.
invoice_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The invoice date as specificed by the sender, in Internet date and time format. Only UTC is supported in response. For example, yyyy-MM-ddTz.
payment_termobjectThe payment term of the invoice. Payment can be due upon receipt, a specified date, or in a set number of days.
The payment due date for the invoice. Value is either but not both term_type or due_date.
metadataobjectThe audit metadata. Captures all invoicing actions on create, send, update, and cancel.
invoicerobjectThe invoicer business information that appears on the invoice.
The invoicer information. Includes the business name, email, address, phone, fax, tax ID, additional notes, and logo URL.
primary_recipientsarrayThe billing and shipping information. Includes name, email, address, phone and language.
itemsobjectThe billing and shipping information. Includes name, email, address, phone, and language.
billing_infoobjectThe billing information of the invoice recipient. Includes name, address, email, phone, and language.
email_addressobject^(?!\.)(?:[A-Za-z0-9!#$&'*\/=?^`{|}~_%+-]|\.(?!\.)){1,64}(?<!\.)@(?:[A-Za-z0-9-]|\.(?!\.))+\.[a-zA-Z]{2,}$The internationalized email address with more restrictive rules. This version restricts the local-part to a dot-atom as defined in https://www.ietf.org/rfc/rfc5322.txt. It does not allow for a quoted-string or an obs-local-part.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
The invoice recipient email address. If you omit this value, the invoice is payable and a notification email is not sent.
phonesarrayThe invoice recipient's phone numbers. Extension number is not supported.
itemsobjectThe phone details. Includes the phone number and type.
additional_infostring^[\S\s]*$Any additional information about the recipient.
languageobject^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}|[0-9]{3}))?$The language tag for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the ISO 639-2 language code, the optional ISO-15924 script tag, and the ISO-3166 alpha-2 country code or M49 region code.
The language in which to show the invoice recipient's email message. Used only when the recipient does not have a PayPal account. If you omit the language and the recipient does not have a PayPal account, the email message is sent in the language of the merchant's PayPal account.
shipping_infoobjectThe contact information of the user. Includes name and address.
The recipient's shipping information. Includes the user's contact information, which includes name and address.
additional_recipientsarrayAn array of one or more CC: emails to which notifications are sent. If you omit this parameter, a notification is sent to all CC: email addresses that are part of the invoice.
Note: Valid values are email addresses in the additional_recipients value associated with the invoice.itemsobject^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$The internationalized email address.
Note: Up to 64 characters are allowed before and 255 characters are allowed after the@sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted@sign exists.
itemsarrayAn array of invoice line item information.
itemsobjectAn array of invoice line item information. The maximum items for an invoice is 100.
idstring^[\S\s]*$The ID of the invoice line item.
namerequiredstring^[\S\s]*$The item name for the invoice line item.
descriptionstring^[\S\s]*$The item description for the invoice line item.
quantityrequiredstring^\d+(.\d{1,5})?$The quantity of the item that the invoicer provides to the payer. Value is from -1000000 to 1000000. Supports up to five decimal places.
unit_amountrequiredobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The unit price of the item. This does not include tax and discount. Value is from -1000000 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxobjectThe tax information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.
The tax associated with the item. The tax amount is added to the item total. Value is from 0 to 100. Supports up to five decimal places.
namerequiredstring^[\s\S]*$The name of the tax applied on the invoice items.
percentrequiredobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_notestring^[\s\S]*$The tax note used to track the tax related data.
item_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The date when the item or service was provided, in Internet date and time format. For example, yyyy-MM-ddTz.
discountobjectThe discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.
percentobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.unit_of_measureobject"QUANTITY", "HOURS", "AMOUNT"The unit of measure for the invoiced item.
The unit of measure for the invoiced item. For AMOUNT the unit_amount and quantity are not shown on the invoice.
Note: If your specify different unit_of_measure values for the same invoice, the invoice uses the first value.configurationobjectThe invoice configuration details. Includes partial payment, tip, and tax calculated after discount.
template_idstring^[\S\s]*$"PayPal system template"The template ID. The template determines the layout of the invoice. Includes which fields to show and hide.
Note: This is an optional field. If you wish to customize the invoice layout using a specific template, provide a valid template ID here. You can either use an existing template ID or create a new template via the create template API and then use the newly created template's ID.
payment_method_overridesarrayThe payment method override configurations for the invoice. Defines which payment methods are enabled and any rules that control payment behavior. When provided during invoice creation or update, this array replaces any existing payment method override configuration for the invoice.
Note: Payment method availability depends on the merchant's country, the buyer's country, and the invoice amount. Override configurations only take effect if the specified payment method is available for the invoice.
itemsobjectThe details about a payment method override configured for the invoice via payment method overrides object.
payment_method_typestring"PAY_BY_BANK", "ACH"The payment method types that can be configured in the payment method overrides object for invoice payments.
Note: To usePAY_BY_BANK, you must first complete the onboarding process. Visit the onboarding page to get started. Once onboarding is complete, you can configurePAY_BY_BANKas a payment method.
enabledbooleanIndicates whether the specified payment method is enabled for the invoice. When set to true, the payment method is available for the buyer to use. When set to false, the payment method is disabled.
rulesarrayThe list of payment method override rules applied to the invoice via payment method overrides object. Each rule defines a specific restriction or behavior for the payment method, such as making it the exclusive payment option when the invoice total exceeds a system-defined threshold.
itemsobjectThe details about a payment method override rule applied to the invoice via payment method overrides object.
rule_typerequiredstring"EXCLUSIVE_ABOVE_AMOUNT_THRESHOLD", "ALLOW_ONLY_ACH"The type of rule that can be applied to a payment method configured via payment method overrides object on an invoice. Each rule controls how a payment method behaves based on the invoice total.
System-defined threshold limits by payment method:
- PAY_BY_BANK - $1000
rule_valuerequiredstring^[a-zA-Z0-9\s,.]+$The value associated with the payment method override rule. For the EXCLUSIVE_ABOVE_AMOUNT_THRESHOLD rule type, set this to true to enable the rule or false to disable it.
themeobjectThe theme configuration that defines the visual appearance of the invoice buyer experience and email. Pass an empty object to use the default theme.
primary_colorstring^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$The primary color chosen by the merchant for branding the invoice buyer experience and email. Accepts a hex color code in #RGB or #RRGGBB format.
amountobjectThe invoice amount summary of item total, discount, tax total, and shipping.
currency_codestring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuestring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.breakdownobjectThe breakdown of the amount. Includes total item amount, total tax amount, custom amount, and shipping and discounts, if any.
item_totalobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.discountobjectThe discount. Can be an item- or invoice-level discount, or both. Can be applied as a percent or amount. If you provide both amount and percent, amount takes precedent.
invoice_discountobjectThe discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.
percentobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.item_discountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The discount as a percent or amount at item level. The item discount amount is subtracted from each item amount.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_totalobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The aggregated amount of the item and shipping taxes.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shippingobjectThe shipping fee for all items. Includes tax on shipping.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The shipping amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxobjectThe tax information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.
The tax associated with the shipping.
namerequiredstring^[\s\S]*$The name of the tax applied on the invoice items.
percentrequiredobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_notestring^[\s\S]*$The tax note used to track the tax related data.
customobjectThe custom amount to apply to an invoice. If you include a label, you must include a custom amount.
labelrequiredstring^[\S\s]*$The label to the custom amount of the invoice.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The custom amount value. Value is from -1000000 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.settingsobjectThe settings for the invoice.
invoice_item_settingsarrayThe settings for the invoice items.
itemsobjectThe invoice item setting.
field_namestring"ITEM_DESCRIPTION", "ITEM_DATE", "ITEM_TAX", "ITEM_DISCOUNT"The field name for the invoice item.
display_preferenceobjectThe display preference of the field.
hiddenbooleanIndicates whether to show or hide the field.
invoice_additional_settingsarrayThe settings for the invoice additional fields.
itemsobjectThe invoice additional setting.
field_namestring"ATTACHMENT", "MEMO", "REFERENCE"The field names for additional sections in the invoice.
display_preferenceobjectThe display preference of the field.
hiddenbooleanIndicates whether to show or hide the field.
invoice_policy_and_agreement_settingsarrayThe settings for the invoice policy and agreement fields.
itemsobjectThe invoice policy and agreement setting.
field_namestring"CANCELLATION_POLICY", "PAYMENT_TERMS", "RETURN_POLICY", "SERVICE_AGREEMENT", "TERMS_AND_CONDITIONS"The field names for the policy and agreement details in the invoice.
display_preferenceobjectThe display preference of the field.
hiddenbooleanIndicates whether to show or hide the field.
invoice_details_settingsarrayThe settings for the invoice details fields.
itemsobjectThe invoice details setting.
field_namestring"ORDER_DETAILS", "PROJECT_DETAILS", "SERVICE_DETAILS"The field names for the invoice details.
display_preferenceobjectThe display preference of the field.
hiddenbooleanIndicates whether to show or hide the field.
due_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The due amount, which is the balance amount outstanding after payments.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.gratuityobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The amount paid by the payer as gratuity to the invoicer.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.paymentsobjectAn array of payments registered against the invoice.
paid_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The aggregated payment amounts against this invoice.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.transactionsarrayAn array of payment details for the invoice. The payment details of the invoice like payment type, method, date, discount and transaction type.
itemsobjectThe payment details of the invoice. Includes payment type, method, date, discount, and transaction type.
typeobject"PAYPAL", "EXTERNAL"The payment type. Can be PayPal or an external payment. Includes cash or a check.
The payment type in an invoicing flow which can be PayPal or an external cash or check payment.
payment_idstring^[\S\s]*$The ID for a PayPal payment transaction. Required for the PAYPAL payment type.
payment_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The date when the invoice was paid, in Internet date and time format. For example, yyyy-MM-dd z.
payment_date_timeobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$The date and time, in Internet date and time format. Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
The date-time when the invoice was paid. For example, yyyy-MM-dd T HH: mm: ss z. The time zone will be UTC.
methodrequiredstring"BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"The payment mode or method through which the invoicer can accept the payments.
notestring^[\S\s]*$A note associated with an external cash or check payment.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The payment amount to record against the invoice. If you omit this parameter, the total invoice amount is marked as paid. This amount cannot exceed the amount due.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shipping_infoobjectThe contact information of the user. Includes name and address.
The recipient's shipping information. Includes the user's contact information, which includes name and address.
effective_invoice_totalobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The effective total amount of the invoice after applying conditional rules. The conditional rules include early payment discount, late payment surcharge, and auto cancellation details.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.effective_due_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The effective due amount of the invoice after applying conditional rules. The conditional rules include early payment discount, late payment surcharge, and auto cancellation details.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.refundsobjectThe invoicing refund details. Includes the refund type, date, amount, and method.
refund_amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The aggregated refund amounts.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.transactionsarrayAn array of refund details for the invoice. Includes the refund type, date, amount, and method.
itemsobjectThe refund details of the invoice. Includes the refund type, date, amount, and method.
typeobject"PAYPAL", "EXTERNAL"The payment type. Can be PayPal or an external payment. Includes cash or a check.
The PayPal refund type. Indicates whether the refund was paid through PayPal or externally in the invoicing flow. The record refund method supports the EXTERNAL refund type. The PAYPAL refund type is supported for backward compatibility.
refund_idstring^[\S\s]*$The ID for a PayPal payment transaction. Required for the PAYPAL payment type.
refund_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The date when the invoice was refunded, in Internet date format. For example, 2014-02-27.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The amount to record as refunded. If you omit the amount, the total invoice paid amount is recorded as refunded.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.methodrequiredstring"BANK_TRANSFER", "CASH", "CHECK", "CREDIT_CARD", "DEBIT_CARD", "PAYPAL", "WIRE_TRANSFER", "OTHER"The payment mode or method through which the invoicer can accept the payments.
linksarrayAn array of request-related HATEOAS links.
itemsobjectThe request-related HATEOAS link information.
hrefrequiredstring^.*$The complete target URL. To make the related call, combine the method with this URI Template-formatted link. For pre-processing, include the $, (, and ) characters. The href is the key HATEOAS component that links a completed call with a subsequent call.
relrequiredstring^.*$The link relation type, which serves as an ID for a link that unambiguously describes the semantics of the link. See Link Relations.
methodstring"CONNECT", "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"The HTTP method required to make the related call.