Skip to content

Pricing Templates

A pricing template defines the processing fees offered to a merchant.

Pricing templates belong to the partner account. They are created and managed in the partner dashboard. Fee values are not returned by the API.

A merchant application uses pricing templates in one of the following ways:

  • One pricing template identifier places the merchant directly on that template.
  • Several pricing template identifiers let the merchant choose one of them.
  • No pricing template identifiers offer the templates marked as default.

These endpoints require a partner API token.

This Pricing Templates group consists of the following endpoint:

Operations

Lists pricing templates

Request

GET {{baseURL}}/v2/pricing-templates

This endpoint lists the pricing templates for the partner account.

Each entry returns the template's id, name, displayName, and isDefault values. It does not return the fee values. Pricing is managed in the partner dashboard.

Use the id values in pricingTemplateIds when creating a merchant application. One identifier places the merchant directly on that template. Several identifiers let the merchant choose one of them. Templates marked isDefault are offered when an application is created without pricingTemplateIds.

All templates are returned in one response. The list is not paginated.

This endpoint requires a partner API token. A merchant API token will result in a permissions error including possibly a 403 response.

Security
Bearer
GET /v2/pricing-templates HTTP/1.1
Host: sandbox.api.flute.com
Authorization: Bearer <YOUR_JWT_HERE>
Accept: application/json

Responses

OK

Bodyapplication/json
itemsArray of objects

Indicates an object list of the partner's pricing templates.

All templates are returned in one response. The list is not paginated. The list is empty if the partner has no pricing templates.

Response

Shows every response field.

{
  "items": [
    {
      "id": "e0b5c0d3-7f4d-4b0a-8e5c-4d5e6f708192",
      "name": "Flat Rate",
      "displayName": "Flat Rate: fees paid by the merchant",
      "isDefault": true
    }
  ]
}