Configuring Merchant Pricing

Use the Merchant Pricing API to create or update pricing plans during merchant onboarding. This helps to configure the transaction fees, service charges, and other cost-related configurations that align with each merchant’s business needs.

Customizable Pricing Plans:

  • Defines flexible pricing structures based on your business requirements. Each plan can include specific fee types, rates, and service charges.

Transparent and Competitive Rates:

  • Configure pricing using predefined templates or customize plans to match individual merchant operations.

It supports both POST and PUT methods to manage merchant pricing efficiently and maintain transparent, business-aligned rate structures.

1

Create a Pricing Plan

Use POST method with endpoint /api/pricing/v2/PricingPlan/{merchantNumber} to assign a new pricing plan to a merchant. Refer to the below request sample code for reference:

{
  "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-09-08T08:21:53.300Z",
  "effectiveEndDateTimeUTC": "2025-09-08T08:21:53.300Z"
}

Refer to the below sample response code for reference:

{
  "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-09-08T08:21:53.300Z",
  "effectiveEndDateTimeUTC": "2025-09-08T08:21:53.300Z"
}
2

Update a Pricing Plan

Use PUT method with endpoint /api/pricing/v2/PricingPlan/{merchantNumber}/{id} to modify an existing pricing plan assigned to a merchant. Refer to the below request sample code for reference:

{
  "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-09-08T08:21:53.300Z",
  "effectiveEndDateTimeUTC": "2025-09-08T08:21:53.300Z"
}

Refer to the below sample response code for reference:

{
  "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-09-08T08:21:53.300Z",
  "effectiveEndDateTimeUTC": "2025-09-08T08:21:53.300Z"
}

Last updated

Was this helpful?