PricingPlanV2
Merchant number.
falsefalseGET /api/pricing/v2/PricingPlan/{merchantNumber} HTTP/1.1
Host:
Accept: */*
{
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"merchantNumber": "text",
"discountQualificationRangeID": 1,
"signatureDebitDiscountQualificationRangeID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true,
"effectiveStartDateTimeUTC": "2025-07-09T09:04:07.321Z",
"effectiveEndDateTimeUTC": "2025-07-09T09:04:07.321Z"
}Merchant number.
falsefalseThe identifier for this pricing plan.
The id of the pricing template that should be used to validate this pricing plan. These are assigned at the partner level and will be provided by your integration specialist.
The identifier for the merchant.
This value will be provided by your integration specialist.
This value will be provided by your integration specialist.
This value will be provided by your integration specialist.
This value will be provided by your integration specialist.
Enrolls the merchant in Clearent's EMF (Express Merchant Funding) program, giving them next-business-day funding of batches submitted prior to 11:00 p.m. Eastern Time.
Governs the settlement of transaction fees: If IsDailySettle is set to true, fees will be deducted from the merchant's daily deposit. If IsDailySettle is set to false, fees will be deducted from the merchant's bank account at the end of the month (Note: a Month End Billing Option fee may apply to transactions that have fees settled monthly).
"Governs the billing of certain card brand fees including but not limited to: Assessments, Foreign Card Fees, Authorization Fees (e.g. NABU, APF), Visa Fees (TIF, FANF, ZFL, Auth Misuse), and Network Fees. As a general guideline: This should be set to false if the merchant is on a flat-rate or two-tier pricing plan, as the Discount Rate(or Card-Present/Card-Not-Present Transaction Fees) are set high enough to cover these items. This should be set to true if the merchant is on a Tiered pricing plan, as the Discount Rate is set to cover Interchange, but not these other fees. This should not be available in the template for IC Plus pricing plans, as it must be set to ""Y"" and not left to the client's discretion."
The pricing plan will become active starting with this date.
The pricing plan will remain active up to this date.
POST /api/pricing/v2/PricingPlan/{merchantNumber} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 490
{
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"merchantNumber": "text",
"discountQualificationRangeID": 1,
"signatureDebitDiscountQualificationRangeID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true,
"effectiveStartDateTimeUTC": "2025-07-09T09:04:07.321Z",
"effectiveEndDateTimeUTC": "2025-07-09T09:04:07.321Z"
}{
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"merchantNumber": "text",
"discountQualificationRangeID": 1,
"signatureDebitDiscountQualificationRangeID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true,
"effectiveStartDateTimeUTC": "2025-07-09T09:04:07.321Z",
"effectiveEndDateTimeUTC": "2025-07-09T09:04:07.321Z"
}Merchant number.
DELETE /api/pricing/v2/PricingPlan/{merchantNumber} HTTP/1.1
Host:
Accept: */*
{
"errors": [
{
"errorMessage": "text",
"resultCode": 1,
"timeStamp": "2025-07-09T09:04:07.321Z",
"fieldPath": [
"text"
],
"pricingFeeIds": [
1
]
}
],
"timeStamp": "2025-07-09T09:04:07.321Z"
}Merchant number.
falsefalseGET /api/pricing/v2/PricingPlan/All/{merchantNumber} HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"merchantNumber": "text",
"discountQualificationRangeID": 1,
"signatureDebitDiscountQualificationRangeID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true,
"effectiveStartDateTimeUTC": "2025-07-09T09:04:07.321Z",
"effectiveEndDateTimeUTC": "2025-07-09T09:04:07.321Z"
}
]
}Merchant number.
Pricing plan ID.
falsefalseThe identifier for this pricing plan.
The id of the pricing template that should be used to validate this pricing plan. These are assigned at the partner level and will be provided by your integration specialist.
The identifier for the merchant.
This value will be provided by your integration specialist.
This value will be provided by your integration specialist.
This value will be provided by your integration specialist.
This value will be provided by your integration specialist.
Enrolls the merchant in Clearent's EMF (Express Merchant Funding) program, giving them next-business-day funding of batches submitted prior to 11:00 p.m. Eastern Time.
Governs the settlement of transaction fees: If IsDailySettle is set to true, fees will be deducted from the merchant's daily deposit. If IsDailySettle is set to false, fees will be deducted from the merchant's bank account at the end of the month (Note: a Month End Billing Option fee may apply to transactions that have fees settled monthly).
"Governs the billing of certain card brand fees including but not limited to: Assessments, Foreign Card Fees, Authorization Fees (e.g. NABU, APF), Visa Fees (TIF, FANF, ZFL, Auth Misuse), and Network Fees. As a general guideline: This should be set to false if the merchant is on a flat-rate or two-tier pricing plan, as the Discount Rate(or Card-Present/Card-Not-Present Transaction Fees) are set high enough to cover these items. This should be set to true if the merchant is on a Tiered pricing plan, as the Discount Rate is set to cover Interchange, but not these other fees. This should not be available in the template for IC Plus pricing plans, as it must be set to ""Y"" and not left to the client's discretion."
The pricing plan will become active starting with this date.
The pricing plan will remain active up to this date.
PUT /api/pricing/v2/PricingPlan/{merchantNumber}/{id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 490
{
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"merchantNumber": "text",
"discountQualificationRangeID": 1,
"signatureDebitDiscountQualificationRangeID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true,
"effectiveStartDateTimeUTC": "2025-07-09T09:04:07.321Z",
"effectiveEndDateTimeUTC": "2025-07-09T09:04:07.321Z"
}{
"pricingFees": [
{
"clearentPricingFeeID": 1,
"pricingFeeDescription": "text",
"rate": 1,
"fee": 1,
"payInMonth1": 1,
"payInMonth2": 1
}
],
"pricingPlanID": 1,
"pricingPlanTemplateID": 1,
"merchantNumber": "text",
"discountQualificationRangeID": 1,
"signatureDebitDiscountQualificationRangeID": 1,
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isEMF": true,
"isDailySettle": true,
"includeAssessments": true,
"effectiveStartDateTimeUTC": "2025-07-09T09:04:07.321Z",
"effectiveEndDateTimeUTC": "2025-07-09T09:04:07.321Z"
}Merchant number.
DELETE /api/pricing/v2/PricingPlan/{merchantNumber}/{pricingPlanID} HTTP/1.1
Host:
Accept: */*
{
"errors": [
{
"errorMessage": "text",
"resultCode": 1,
"timeStamp": "2025-07-09T09:04:07.321Z",
"fieldPath": [
"text"
],
"pricingFeeIds": [
1
]
}
],
"timeStamp": "2025-07-09T09:04:07.321Z"
}Returns a list of available templates.
Passing in values with any of the filter parameters will cause the list to exclude templates that are incompatible with those values.
Merchant number.
Causes rates to be represented as values that are out of 100 rather than out of 1.
falseCauses the API to more directly mirror the way that fees are displayed on user interfaces.
falseThe MCC Code to be used when determining if a merchant can use a specific template.
The 2 letter State Code to be used when determining if a merchant can use a specific template.
The E-Comm Percentage to be used when determining if a merchant can use a specific template.
The Card Type Codes to be used when determining if a merchant can use a specific template.
GET /api/pricing/v2/PricingPlan/{merchantNumber}/templates HTTP/1.1
Host:
Accept: */*
{
"content": [
{
"pricingPlanTemplateID": 1,
"hierarchyNodeKey": "text",
"templateName": "text",
"pricingTypeCode": "text",
"isAdvancedPricing": true,
"isDefaultTemplate": true,
"isDisabled": true,
"templateFees": [
{
"clearentPricingFeeID": 1,
"clearentPricingFeeDescription": "text",
"isEditable": true,
"isRequired": true,
"isVisible": true,
"isFee": true,
"isRate": true,
"isPayInMonthRequired1": true,
"isPayInMonthRequired2": true,
"defaultRate": 1,
"minRate": 1,
"maxRate": 1,
"defaultFee": 1,
"minFee": 1,
"maxFee": 1,
"rateLabel": "text",
"feeLabel": "text"
}
],
"templateSettings": [
{
"pricingPlanSettingID": 1,
"settingName": "text",
"description": "text",
"isVisible": true,
"isEditable": true,
"defaultValue": true
}
],
"attributes": [
{
"name": "text",
"value": "text",
"type": "text"
}
]
}
]
}Can be used to check whether a specific merchant is eligible to use a specific template.
Attributes can be passed in for more specific information about why a merchant is or is not eligible.
Merchant number.
The Pricing Plan Template ID of the plan whose eligibility should be verified.
The MCC Code to be used when determining if a merchant can use a specific template.
The 2 letter State Code to be used when determining if a merchant can use a specific template.
The E-Comm Percentage to be used when determining if a merchant can use a specific template.
The Card Type Codes to be used when determining if a merchant can use a specific template.
GET /api/pricing/v2/PricingPlan/{merchantNumber}/templates/{pricingPlanTemplateId}/eligibility HTTP/1.1
Host:
Accept: */*
{
"isEligible": true,
"inelegibilityReasons": [
"text"
]
}Merchant number.
GET /api/pricing/v2/PricingPlan/{merchantNumber}/empowerAttributes HTTP/1.1
Host:
Accept: */*
{
"isEligibleForValidation": true,
"isEmpower": true,
"surchargeMin": 1,
"surchargeMax": 1,
"surchargeIsRate": true,
"empowerProgram": "text",
"isEmf": true
}Was this helpful?