Pricing Plan

The Pricing Plan API enables integrators to configure credit card processing fees and settings for their merchants. The API is built around two core concepts that work together to provide flexible pricing configuration.

• Pricing Plan Templates: Define sets of fees and configuration constraints—what fees are available, required, and their min/max values.

• Pricing Plans: Assign fees and configure settings for a specific merchant. Each plan must be:

  • Associated with a specific Pricing Plan Template

  • Comply with all template constraints

Base URLs

Environment	URL
Sandbox	https://boarding-sb.clearent.net/api/
Production	https://boarding.clearent.net/api/

Headers

Content-Type: application/json
Accept: application/json
AccessKey: Secret access key issued by Xplor Pay
MerchantId: Id of the merchant

Available Endpoints

PricingPlanV2:

• Get a Pricing Plan:

  • GET /api/pricing/v2/PricingPlan/{merchantNumber}

• Create a Pricing Plan:

  • POST /api/pricing/v2/PricingPlan/{merchantNumber}

• Update a Pricing Plan:

  • PUT /api/pricing/v2/PricingPlan/{merchantNumber}/{id}

• Delete a Pricing Plan by Merchant Number:

  • DELETE /api/pricing/v2/PricingPlan/{merchantNumber}

• Delete a Pricing Plan by Pricing Plan ID:

  • DELETE /api/pricing/v2/PricingPlan/{merchantNumber}/{pricingPlanID}

• List All Pricing Plans for a Merchant:

  • GET /api/pricing/v2/PricingPlan/All/{merchantNumber}

• Get Available Templates:

  • GET /api/pricing/v2/PricingPlan/{merchantNumber}/templates

• Check Template Eligibility:

  • GET /api/pricing/v2/PricingPlan/{merchantNumber}/templates/{pricingPlanTemplateId}/eligibility

• Get Empower Attributes:

  • GET /api/pricing/v2/PricingPlan/{merchantNumber}/empowerAttributes

Reference:

• Get “Pay In Month” Reference Values:

  • GET /api/pricing/v2/Reference/PayInMonth

• Get “Display Type Code” Reference Values:

  • GET /api/pricing/v2/Reference/DisplayTypeCode

Path Parameters

Name	Data Type	Required?	Description
merchantNumber	String	Required	Merchant identifier
Id	Integer	Required	Pricing plan ID
pricingPlanID	Integer	Required	Pricing plan ID

Additional Information

Sample Usage Workflow

1. Retrieve a list of the Pricing Plan Templates that are available to you from the PricingPlanTemplate/All/{MerchantId} endpoint

2. Choose one of the available Pricing Plan Templates as the basis for creating a new Pricing Plan

3. Create a Pricing Plan that complies with the values on the Pricing Plan Template

4. Send POST and PUT requests to the PricingPlan/{MerchantId} endpoints to create and update the new Pricing Plan

To see a simplified example of this sample workflow, look under the Tests tab on the "Pricing - Get Available Templates" request in the sample Postman collection here.