Skip to content

Update the price plan

PUT
/v1/admin/payouts/payout-entities/{payout_entity_id}/price-plan/

Creates a new version of the price plan with the fees you send. Send the complete list; an empty list is a plan without fees.

Authorization

apiKey
headerAuthorizationBasic <token>

HTTP Basic authentication with an admin API key as the username and an empty password.

Path Parameters

payout_entity_id*string

The ID of the payout entity.

Formatuuid

Request Body

application/json
  1. body

The fees of a payout entity. Amounts are in the smallest currency unit; percentages are strings with two or three decimals. Each combination of transaction type and outcome uses either ic_plus_plus or blended_fee, not both. See Price plans.

fees*array<||||>

Response Body

The new version of the price plan.

curl -X PUT 'https://api.example.com/v1/admin/payouts/payout-entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/price-plan/' \  --user "$API_KEY:" \  -H 'Content-Type: application/json' \  -d '{  "fees": [    {      "type": "ic_plus_plus",      "name": "Card markup",      "currency": "EUR",      "transaction_types": [        "sale",        "capture"      ],      "outcomes": [        "accepted"      ],      "amount": 5,      "rate_percentage": "0.20"    },    {      "type": "chargeback_tier_fee",      "name": "Visa chargebacks",      "currency": "EUR",      "card_scheme": "visa",      "interval": "monthly",      "bands": [        {          "from_percentage": "0.00",          "to_percentage": "1.00",          "amount": 0        },        {          "from_percentage": "1.00",          "to_percentage": null,          "amount": 5000        }      ]    }  ]}'
Empty