Retrieves a merchant's invoice settings

Request

GET {{baseURL}}/pay-int-api/merchants/{{merchantId}}/invoices/settings

This endpoint retrieves the specified merchant's invoice settings.

These settings control how invoices behave for that merchant. This includes:

whether line item prices can be overwritten
whether shipping fees, taxes, and discounts are enabled
which payment methods are accepted
how many days after issue an invoice becomes due

This is a read-only lookup, so no request body is needed.

It is intended for confirming a merchant's current configuration before attempting operations that depend on it. For example, such as overriding a line item's unit price on an invoice.

See Also:
To update a merchant's invoice settings, see PUT /pay-int-api/merchants/{merchantId}/invoices/settings.

Security

Bearer

Path

merchantIdstring, (uuid)required

Specifies the identifier of the merchant.

Example:46063d32-10fa-44cb-b118-20ddd085ce3f

x-api-versionstring

Specifies the API version to use for the request.

Example: 1.0

Example:1.0

curl -i -X GET \
  https://developer.flute.com/_mock/api-reference/pay-int-api/merchants/46063d32-10fa-44cb-b118-20ddd085ce3f/invoices/settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-version: 1.0'

Responses

Bodyapplication/json

merchantIdstring, (uuid)

Indicates the identifier of the merchant.

Example: 46063d32-10fa-44cb-b118-20ddd085ce3f

Example:"46063d32-10fa-44cb-b118-20ddd085ce3f"

dueDateAfterDaysinteger or null, (int32)

Indicates the number of days after issuance that an invoice is due.

Example: 30

Example:30

taxPercentagenumber or null, (double)

Indicates the tax percentage.

Example: 8.50 (as 8.50%)

Example:8.5

isDiscountEnabledboolean

Indicates the discount is enabled.

If true, the discount is enabled.
If false, the discount is not enabled.

Example: true

Example:true

discountPercentagenumber or null, (double)

Indicates the discount percentage.

Example: 1.5 (as 1.5%)

Example:1.5

isShippingFeeEnabledboolean

Indicates the shipping fee is enabled.

If true, the shipping fee is enabled.
If false, the shipping fee is not enabled.

Example: true

Example:true

shippingFeeAmountnumber or null, (double)

Indicates the shipping fee amount.

Example: 5.00

Example:5

isFeesEnabledboolean

Specifies fees are enabled.

If true, fees are enabled.
If false, fees are not enabled.

Example: true

Example:true

feesPercentagenumber or null, (double)

Indicates the fees percentage.

Example: 10.25 (as 10.25%)

Example:10.25

notesstring or null

Indicates default notes shown on an invoice.

Example: Thank you for your business.

Example:"Thank you for your business."

paymentMethodTypeIdinteger, (int32)

Indicates the payment method type identifier.

Value values:

Id	Name
1	Card (for credit card)
2	ElectronicCheck

Example: 2

Example:2

cardPaymentProcessorIdstring or null, (uuid)

Specifies an identifier for the credit card payment processor handling a card transaction.

Example: 78723ff2-d47e-460b-b838-d602bdf0e1bc

Example:"78723ff2-d47e-460b-b838-d602bdf0e1bc"

achPaymentProcessorIdstring or null, (uuid)

Specifies an identifier for the automated clearing house (ACH) payment processor handling a transaction.

Example: 9925a0b0-eb18-4d74-8967-7e0cf6af0729

Example:"9925a0b0-eb18-4d74-8967-7e0cf6af0729"

allowStaffToSetDiscountAndLineItemDiscountboolean

Indicates staff members are allowed to set a discount and line item discount.

If true, staff can set a discount and a line item discount.
If false, staff cannot set a discount or a line item discount.

Example: true

Example:true

allowManuallyEnterLineItemsboolean

For internal use only.

Do not use.

isSmsNotificationAfterPaymentEnabledboolean

Indicates an SMS notification is sent to the customer after a successful payment.

If true, an SMS notification is sent after payment succeeds.
If false, no SMS notification is sent after payment succeeds.

Example: true

Example:true

isSmsNotificationAfterPaymentFailedEnabledboolean

Indicates an SMS notification is sent to the customer after a failed payment.

If true, an SMS notification is sent after payment fails.
If false, no SMS notification is sent after payment fails.

Example: true

Example:true

canOverWriteInvoiceLineItemPriceboolean

Indicates a line item's unit price can be overwritten on an invoice.

If true, a line item's unitPrice can be overwritten from its catalog price.
If false, a line item's unitPrice must match its catalog price and cannot be overwritten.

Example: true

Example:true

newZcpFeatureEnabledboolean

Indicates the new ZCP (zero cost processing) feature is enabled.

If true, the new ZCP feature is enabled.
If false, the new ZCP feature is not enabled.

Example: true

Example:true

Response

{
  "merchantId": "46063d32-10fa-44cb-b118-20ddd085ce3f",
  "dueDateAfterDays": 30,
  "taxPercentage": 8.5,
  "isDiscountEnabled": true,
  "discountPercentage": 1.5,
  "isShippingFeeEnabled": true,
  "shippingFeeAmount": 5,
  "isFeesEnabled": true,
  "feesPercentage": 10.25,
  "notes": "Thank you for your business.",
  "paymentMethodTypeId": 2,
  "cardPaymentProcessorId": "78723ff2-d47e-460b-b838-d602bdf0e1bc",
  "achPaymentProcessorId": "9925a0b0-eb18-4d74-8967-7e0cf6af0729",
  "allowStaffToSetDiscountAndLineItemDiscount": true,
  "allowManuallyEnterLineItems": true,
  "isSmsNotificationAfterPaymentEnabled": true,
  "isSmsNotificationAfterPaymentFailedEnabled": true,
  "canOverWriteInvoiceLineItemPrice": true,
  "newZcpFeatureEnabled": true
}