---
title: "Get pricing plan"
method: GET
path: "/api/pricing/v2/PricingPlan/{merchantNumber}"
tags: ["PricingPlanV2"]
---

# Get pricing plan

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

Retrieve the pricing plan for a specified merchant.

## Path parameters

- `merchantNumber` string, required

## Query parameters

- `effectiveDate` string, date-time
- `outof100` boolean
- `useDisplayFees` boolean

## Response `200`

Returns a pricing plan successfully.

- BusinessPricingPlan
  - `pricingFees` PlanFee[], nullable — The set of pricing fees which will be applied to this merchant.
    - `clearentPricingFeeID` integer — The identifier for this pricing fee.
    - `pricingFeeDescription` string, nullable — A description of the pricing fee. Not required when creating or updating pricing fee.
    - `rate` number, double, nullable — Used to indicate a percentage of the transaction amount that will be applied as a fee on each transaction of this type.
    - `fee` number, double, nullable — Used to indicate an amount that will be applied as a fee on each transaction of this type. For non-transactional fees, these fees may be applied on a monthly, semi-annual, or annual basis.
    - `payInMonth1` integer, nullable — Used to indicate the month in which annual fees should be billed or the first month in which semi-annual fees should be billed. Otherwise, this field should be set to null.
    - `payInMonth2` integer, nullable — Used to indicate the second month in which semi-annual fees should be billed. Otherwise, this field should be set to null.
  - `pricingPlanID` integer — The identifier for this pricing plan.
  - `pricingPlanTemplateID` integer — 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.
  - `merchantNumber` string, nullable — The identifier for the merchant.
  - `discountQualificationRangeID` integer, nullable — This value will be provided by your integration specialist.
  - `signatureDebitDiscountQualificationRangeID` integer, nullable — This value will be provided by your integration specialist.
  - `pricingTypeCode` string — This value will be provided by your integration specialist.
  - `isAdvancedPricing` boolean — This value will be provided by your integration specialist.
  - `isEMF` boolean — Enrolls the merchant in Xplor Pay’s EMF (Express Merchant Funding) program, giving them next-business-day funding of batches submitted prior to 11:00 p.m. Eastern Time.
  - `isDailySettle` boolean — 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).
  - `includeAssessments` boolean — 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) is 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.
  - `effectiveStartDateTimeUTC` string, date-time, nullable — The pricing plan will become active starting with this date.
  - `effectiveEndDateTimeUTC` string, date-time, nullable — The pricing plan will remain active up to this date.

## Other responses

- `400` — If merchant number is null or empty.
- `404` — If pricing plan not found.
- `500` — Error occurred retrieving pricing plan.

---

[API](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow.md) · [All operations](https://skmtc.net/xplorpay/apis/external-us-onboarding-workflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xplorpay/external-us-onboarding-workflow/revisions/f37077c24b66/schema)