Update a billing profile

Update supported fields on a billing profile. Only fields included in the payload will be updated. Omitted fields will not be updated. A deactivated billing profile cannot be updated.

The updated fees and rates take effect immediately. See Merchant billing profiles for when each fee and rate is applied to a payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
billing_profile_id
array of strings
required

The unique billing profile identifiers.

Prefix is "bpf" in production and "sbx_bpf" in sandbox.

billing_profile_id*
Body Params
string

The unique name of the billing profile.

integer
0 to 25000

Card rate, in per cent mille (1 PCM = 0.001%).

For example, 3000 is 3%.

integer
0 to 10000

Amex card rate surcharge, in per cent mille (1 PCM = 0.001%). This rate will be charged in addition to the card rate.

If a card is also Business or International, then the higher rate will be charged.

For example, 3000 is 3%.

integer
0 to 10000

Business card rate surcharge, in per cent mille (1 PCM = 0.001%). This rate will be charged in addition to the card rate.

If a card is also Amex or International, then the higher rate will be charged.

For example, 3000 is 3%.

integer
0 to 10000

International (non-US) card rate surcharge, in per cent mille (1 PCM = 0.001%). This rate will be charged in addition to the card rate.

If a card is also Amex or Business, then the higher rate will be charged.

For example, 3000 is 3%.

integer
0 to 500

Card fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

Card refund rate, in per cent mille (1 PCM = 0.001%).

For example, 3000 is 3%.

integer
0 to 500

Card refund fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

Fee per card authorization, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

Fee per card authorization void, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 5000

Card dispute fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

Card device rate, in per cent mille (1 PCM = 0.001%).

For example, 3000 is 3%.

integer
0 to 10000

Amex card device rate surcharge, in per cent mille (1 PCM = 0.001%). This rate will be charged in addition to the card device rate.

If a card is also Business or International, then the higher rate will be charged.

For example, 3000 is 3%.

integer
0 to 10000

Business card device rate surcharge, in per cent mille (1 PCM = 0.001%). This rate will be charged in addition to the card device rate.

If a card is also Amex or International, then the higher rate will be charged.

For example, 3000 is 3%.

integer
0 to 10000

International (non-US) card device rate surcharge, in per cent mille (1 PCM = 0.001%). This rate will be charged in addition to the card device rate.

If a card is also Amex or Business, then the higher rate will be charged.

For example, 3000 is 3%.

integer
0 to 500

Card device fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

Card device refund rate, in per cent mille (1 PCM = 0.001%).

For example, 3000 is 3%.

integer
0 to 500

Card device refund fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

Fee per card device authorization, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

Fee per card device authorization void, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

ACH rate, in per cent mille (1 PCM = 0.001%).

For example, 3000 is 3%.

integer
0 to 10000000

ACH rate cap, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

ACH fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

ACH balance check fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

ACH refund rate, in per cent mille (1 PCM = 0.001%).

For example, 3000 is 3%.

integer
0 to 500

ACH refund fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 5000

ACH return fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 5000

ACH dispute fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 500

ACH validation fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

Accelerated ACH rate, in per cent mille (1 PCM = 0.001%).

For example, 3000 is 3%.

integer
0 to 10000000

Accelerated ACH rate cap, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

Accelerated ACH fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 500

ACH frictionless validation fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 10000

Deposit fee, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

Fee per 3DS attempt, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

Card account update attempt, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

Fee per BIN lookup, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 1000

Fee per Tap to Phone attempt, in minor units.

For example, 1000 is 10.00 USD.

integer
0 to 100000

PayPal Wallet rate, in per cent mille (1 PCM = 0.001%).

integer
0 to 1000

PayPal Wallet fee, in minor units.

integer
0 to 100000

PayPal Wallet refund rate, in per cent mille (1 PCM = 0.001%).

integer
0 to 1000

PayPal Wallet refund fee, in minor units.

integer
0 to 5000

PayPal Wallet dispute fee, in minor units.

integer
0 to 1000

Fee per PayPal Wallet authorization, in minor units.

integer
0 to 1000

Fee per PayPal Wallet authorization void, in minor units.

integer
0 to 100000

Venmo rate, in per cent mille (1 PCM = 0.001%).

integer
0 to 1000

Venmo fee, in minor units.

integer
0 to 100000

Venmo refund rate, in per cent mille (1 PCM = 0.001%).

integer
0 to 1000

Venmo refund fee, in minor units.

integer
0 to 5000

Venmo dispute fee, in minor units.

integer
0 to 1000

Fee per Venmo authorization, in minor units.

integer
0 to 1000

Fee per Venmo authorization void, in minor units.

integer
0 to 100000

PayPal Pay Later rate, in per cent mille (1 PCM = 0.001%).

integer
0 to 1000

PayPal Pay Later fee, in minor units.

integer
0 to 100000

PayPal Pay Later refund rate, in per cent mille (1 PCM = 0.001%).

integer
0 to 1000

PayPal Pay Later refund fee, in minor units.

integer
0 to 5000

PayPal Pay Later dispute fee, in minor units.

integer
0 to 1000

Fee per PayPal Pay Later authorization, in minor units.

integer
0 to 1000

Fee per PayPal Pay Later authorization void, in minor units.

Headers
string
enum
Defaults to 2024-10-16
Allowed:
Responses

Language
Credentials
Bearer
APIKey
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json