--- title: "List pricing intents" method: GET path: "/pricing-intents" tags: ["pricingIntents"] --- # List pricing intents `GET /pricing-intents` Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of pricing intents associated with the ISV. **Note:** If you want to view the details of a specific pricing intent and you have its pricingIntentId, use our [Retrieve Pricing Intent](https://docs.payroc.com/api/schema/boarding/pricing-intents/retrieve) method. Our gateway returns the following information about each pricing intent in the list: - Information about the fees, including the base fees, gateway fees, and processor fees. - Status of the pricing intent, including whether we approved the pricing intent. For each pricing intent, we also return its pricingIntentId which you can use to perform follow-on actions. ## Query parameters - `before` string - `after` string - `limit` integer ## Headers - `Authorization` string, required ## Response `200` Successful response. Returns a list of pricing intents. - PaginatedPricingIntent — Object that contains information about your pricing intents. - `limit` integer — Maximum number of results that we return for each page. - `count` integer — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query. - `hasMore` boolean — Indicates whether there is another page of results available. - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results. - `rel` string, required — Indicates the relationship between the current resource and the target resource. - `method` string, required — HTTP method that you need to use with the target resource. - `href` string, required — URL of the target resource. - `data` PricingIntent[] — Array of pricing intent objects. - union — Polymorphic object that contains pricing intent information. - PricingIntent50 — Object that contains information about a pricing intent for Merchant Processing Agreement (MPA) 5.0. - `id` string — Unique identifier of the pricing intent. - `createdDate` string, date-time — Date and time that we received your request to create the pricing intent. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - `lastUpdatedDate` string, date-time — Date and time that the pricing intent was last modified. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - `status` 'active' | 'pendingReview' | 'rejected' — Status of the pricing intent. The value can be one of the following: - `active` - We have approved the pricing intent. - `pendingReview` - We have not yet reviewed the pricing intent. - `rejected` - We have rejected the pricing intent. - `key` string, required — Unique identifier that you can assign to the pricing intent for your own records. - `metadata` object — [Metadata](https://docs.payroc.com/api/metadata) object that contains your custom data. - `country` 'US', required — Two-digit code for the country that the pricing intent applies to. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard. - `version` '5.0', required — Version of the MPA. - `base` BaseUs, required — Object that contains information about U.S. base fees. - `addressVerification` integer, nullable, required — Fee for each address verification request. The value is in the currency's lowest denomination, for example, cents. - `annualFee` BaseUsAnnualFee, required — Object that contains information about the annual fee. - `billInMonth` 'june' | 'december' — Indicates whether we collect the annual fee in June or December. - `amount` integer, required — Annual fee. The value is in the currency's lowest denomination, for example, cents. - `regulatoryAssistanceProgram` integer, nullable, required — Annual fee for the regulatory assistance program. The value is in the currency's lowest denomination, for example, cents. - `pciNonCompliance` integer — Fee that we apply each month if you aren't compliant with PCI standards. The value is in the currency's lowest denomination, for example, cents. - `merchantAdvantage` integer, nullable, required — Monthly fee for Payroc Advantage. The value is in the currency's lowest denomination, for example, cents. - `platinumSecurity` union — Polymorphic object that contains billing details for Platinum Security. The value of the billingFrequency field determines which variant you should use: - `monthly` - We collect the fee for Platinum Security each month. - `annual` - We collect the fee for Platinum Security each year. - object — monthly variant - … - object — annual variant - … - `maintenance` integer, required — Monthly fee for maintenance. The value is in the currency's lowest denomination, for example, cents. - `minimum` integer, required — Monthly fee that we charge when the merchant doesn't meet the minimum fee amount. This monthly fee is in the currency's lowest denomination, for example, cents. - `voiceAuthorization` integer — Fee for each voice authorization. The value is in the currency's lowest denomination, for example, cents. - `chargeback` integer — Fee for each chargeback. The value is in the currency's lowest denomination, for example, cents. - `retrieval` integer — Fee for each retrieval. The value is in the currency's lowest denomination, for example, cents. - `batch` integer, required — Fee for each batch. The value is in the currency's lowest denomination, for example, cents. - `earlyTermination` integer — Fee for early termination. The value is in the currency's lowest denomination, for example, cents. - `processor` PricingIntent50Processor — Object that contains information about U.S. processor fees. - `card` union — Polymorphic object that contains fees for card transactions. The value of the planType field determines which variant you should use: - `interchangePlus` - Interchange + pricing - `interchangePlusPlus` - Interchange pricing with three tiers - `tiered3` - Three-tiered pricing - `tiered4` - Four-tiered pricing - `tiered6` - Six-tiered pricing - `flatRate` - Flat rate pricing - `consumerChoice` - ConsumerChoice - `rewardPayChoice` - RewardPayChoice - object — Object that contains information about Interchange Plus. - … - object — Object that contains information about Interchange Plus Plus. - … - object — Object that contains information about tiered pricing with three tiers. - … - object — Object that contains information about tiered pricing with four tiers. - … - object — Object that contains information about tiered pricing with six tiers. - … - object — Object that contains information about Flat Rate. - … - object — Object that contains information about ConsumerChoice. - … - object — Object that contains information about RewardPayChoice. - … - `ach` Ach — Object that contains the fees for ACH transactions. - `fees` AchFees — Object that contains processing fees for ACH transactions. - … - `gateway` GatewayUs50 — Object that contains information about the gateway fees for MPA 5.0. - `fees` GatewayUs50Fees, required — Object that contains information about the gateway fees. - `monthly` integer, required - `setup` integer, required - `perTransaction` integer, required - `perDeviceMonthly` integer, required - `services` ServiceUs50[] — Array of polymorphic objects that contain information about additional services that we offer. - `name` 'hardwareAdvantagePlan', required — Discriminator value: hardwareAdvantagePlan - `enabled` boolean, required — Indicates if the merchant has signed up for the Hardware Advantage Plan. - PricingIntent52 — Object that contains information about a pricing intent for Merchant Processing Agreement (MPA) 5.2. - `id` string — Unique identifier of the pricing intent. - `createdDate` string, date-time — Date and time that we received your request to create the pricing intent. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - `lastUpdatedDate` string, date-time — Date and time that the pricing intent was last modified. We return this value in the [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - `status` 'active' | 'pendingReview' | 'rejected' — Status of the pricing intent. The value can be one of the following: - `active` - We have approved the pricing intent. - `pendingReview` - We have not yet reviewed the pricing intent. - `rejected` - We have rejected the pricing intent. - `key` string, required — Unique identifier that you can assign to the pricing intent for your own records. - `metadata` object — [Metadata](https://docs.payroc.com/api/metadata) object that contains your custom data. - `country` 'US', required — Two-digit code for the country that the pricing intent applies to. The format follows the [ISO-3166-1](https://www.iso.org/iso-3166-country-codes.html) standard. - `version` '5.2', required — Version of the MPA. - `base` BaseUs52, required — Object that contains information about U.S. base fees. - `addressVerification` integer, nullable, required — Fee for each address verification request. The value is in the currency's lowest denomination, for example, cents. - `annualFee` BaseUs52AnnualFee, required — Object that contains information about the annual fee. - `billInMonth` 'june' | 'december' — Indicates whether we collect the annual fee in June or December. - `amount` integer, required — Annual fee. The value is in the currency's lowest denomination, for example, cents. - `regulatoryAssistanceProgram` integer, nullable, required — Annual fee for the regulatory assistance program. The value is in the currency's lowest denomination, for example, cents. - `pciNonCompliance` integer — Fee that we apply each month if you aren't compliant with PCI standards. The value is in the currency's lowest denomination, for example, cents. - `platinumSecurity` union — Object that contains information about the Platinum Security fee. - object — monthly variant - … - object — annual variant - … - `maintenance` integer, required — Monthly fee for maintenance. The value is in the currency's lowest denomination, for example, cents. - `minimum` integer, required — Monthly fee that we charge when the merchant doesn't meet the minimum fee amount. This monthly fee is in the currency's lowest denomination, for example, cents. - `voiceAuthorization` integer — Fee for each voice authorization. The value is in the currency's lowest denomination, for example, cents. - `chargeback` integer — Fee for each chargeback. The value is in the currency's lowest denomination, for example, cents. - `retrieval` integer — Fee for each retrieval. The value is in the currency's lowest denomination, for example, cents. - `batch` integer, required — Fee for each batch. The value is in the currency's lowest denomination, for example, cents. - `earlyTermination` integer — Fee for early termination. The value is in the currency's lowest denomination, for example, cents. - `processor` PricingIntent52Processor — Object that contains information about U.S. processor fees. - `card` union — Object that contains information about card fees. - object — Object that contains information about Interchange Plus. - … - object — Object that contains information about Interchange Plus Plus. - … - object — Object that contains information about tiered pricing with three tiers. - … - object — Object that contains information about tiered pricing with four tiers. - … - object — Object that contains information about tiered pricing with six tiers. - … - object — Object that contains information about Flat Rate. - … - object — Object that contains information about ConsumerChoice. - … - object — Object that contains information about RewardPayChoice. - … - `ach` Ach — Object that contains the fees for ACH transactions. - `fees` AchFees — Object that contains processing fees for ACH transactions. - … - `gateway` GatewayUs52 — Object that contains information about the gateway fees for MPA 5.2. - `fees` GatewayUs52Fees, required — Object that contains information about the gateway fees. - `monthly` integer, required - `setup` integer, required - `perTransaction` integer, required - `perDeviceMonthly` integer, required - `3dSecurePerTransaction` integer - `tapToPayPerTransaction` integer - `services` ServiceUs52[] — Object that contains information about our additional services that the merchant can sign up for. - union — Object that contains information about the Hardware Advantage Plan. - object — Object that contains information about the Hardware Advantage Plan. - … - object — Object that contains the fees for account updater service. - … - object — Object that contains the fees for wireless processing. - … - object — Object that contains the fees for the Clover platform service. - … - object — Object that contains the fees for the Roc Services gateway. - … ## Other responses - `400` — Invalid request - `401` — Identity could not be verified - `403` — Do not have permissions to perform this action - `500` — An error has occured --- [API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)