Create a billing profile

post

https://api.sandbox.rainforestpay.com/v1/billing_profiles

The first billing profile created will be assigned as the platform's default billing profile for new merchants.

Body Params

platform_id

string

required

The unique platform identifier.

Prefix is "plt" in production and "sbx_plt" in sandbox.

name

string

required

Name of the billing profile

card_rate_type

string

enum

required

Card rate type

card_rate

integer

required

0 to 25000

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

For example, 3000 is 3%.

card_amex_rate_surcharge

integer

required

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%.

card_business_rate_surcharge

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%.

card_international_rate_surcharge

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%.

card_fee

integer

required

0 to 500

Card fee, in minor units.

For example, 1000 is 10.00 USD.

card_refund_rate

integer

required

0 to 10000

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

For example, 3000 is 3%.

card_refund_fee

integer

required

0 to 500

Card refund fee, in minor units.

For example, 1000 is 10.00 USD.

card_auth_fee

integer

0 to 1000

Fee per card authorization, in minor units.

For example, 1000 is 10.00 USD.

card_auth_void_fee

integer

0 to 1000

Fee per card authorization void, in minor units.

For example, 1000 is 10.00 USD.

card_dispute_fee

integer

required

0 to 5000

Card dispute fee, in minor units.

For example, 1000 is 10.00 USD.

card_device_rate

integer

required

0 to 10000

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

For example, 3000 is 3%.

card_device_amex_rate_surcharge

integer

required

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%.

card_device_business_rate_surcharge

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%.

card_device_international_rate_surcharge

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%.

card_device_fee

integer

required

0 to 500

Card device fee, in minor units.

For example, 1000 is 10.00 USD.

card_device_refund_rate

integer

required

0 to 10000

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

For example, 3000 is 3%.

card_device_refund_fee

integer

required

0 to 500

Card device refund fee, in minor units.

For example, 1000 is 10.00 USD.

card_device_auth_fee

integer

0 to 1000

Fee per card device authorization, in minor units.

For example, 1000 is 10.00 USD.

card_device_auth_void_fee

integer

0 to 1000

Fee per card device authorization void, in minor units.

For example, 1000 is 10.00 USD.

ach_rate

integer

required

0 to 10000

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

For example, 3000 is 3%.

ach_rate_cap

integer

required

0 to 10000000

ACH rate cap, in minor units.

For example, 1000 is 10.00 USD.

ach_fee

integer

required

0 to 10000

ACH fee, in minor units.

For example, 1000 is 10.00 USD.

ach_balance_check_fee

integer

0 to 1000

ACH balance check fee, in minor units.

For example, 1000 is 10.00 USD.

ach_refund_rate

integer

required

0 to 10000

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

For example, 3000 is 3%.

ach_refund_fee

integer

required

0 to 500

ACH refund fee, in minor units.

For example, 1000 is 10.00 USD.

ach_return_fee

integer

required

0 to 5000

ACH return fee, in minor units.

For example, 1000 is 10.00 USD.

ach_dispute_fee

integer

required

0 to 5000

ACH dispute fee, in minor units.

For example, 1000 is 10.00 USD.

ach_validation_fee

integer

required

0 to 500

ACH validation fee, in minor units.

For example, 1000 is 10.00 USD.

standard_deposit_fee

integer

required

0 to 10000

Deposit fee, in minor units.

For example, 1000 is 10.00 USD.

threeds_attempt_fee

integer

required

0 to 1000

Fee per 3DS attempt, in minor units.

For example, 1000 is 10.00 USD.

card_account_updater_fee

integer

0 to 1000

Card account update attempt, in minor units.

For example, 1000 is 10.00 USD.

bin_lookup_fee

integer

0 to 1000

Fee per BIN lookup, in minor units.

For example, 1000 is 10.00 USD.

tap_to_phone_fee

integer

0 to 1000

Fee per Tap to Phone attempt, in minor units.

For example, 1000 is 10.00 USD.

paypal_wallet_rate

integer

0 to 100000

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

paypal_wallet_fee

integer

0 to 1000

PayPal Wallet fee, in minor units.

paypal_wallet_refund_rate

integer

0 to 100000

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

paypal_wallet_refund_fee

integer

0 to 1000

PayPal Wallet refund fee, in minor units.

paypal_wallet_dispute_fee

integer

0 to 1000

PayPal Wallet dispute fee, in minor units.

paypal_wallet_auth_fee

integer

0 to 1000

Fee per PayPal Wallet authorization, in minor units.

paypal_wallet_auth_void_fee

integer

0 to 1000

Fee per PayPal Wallet authorization void, in minor units.

venmo_rate

integer

0 to 100000

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

venmo_fee

integer

0 to 1000

Venmo fee, in minor units.

venmo_refund_rate

integer

0 to 100000

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

venmo_refund_fee

integer

0 to 1000

Venmo refund fee, in minor units.

venmo_dispute_fee

integer

0 to 1000

Venmo dispute fee, in minor units.

venmo_auth_fee

integer

0 to 1000

Fee per Venmo authorization, in minor units.

venmo_auth_void_fee

integer

0 to 1000

Fee per Venmo authorization void, in minor units.

paypal_paylater_rate

integer

0 to 100000

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

paypal_paylater_fee

integer

0 to 1000

PayPal Pay Later fee, in minor units.

paypal_paylater_refund_rate

integer

0 to 100000

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

paypal_paylater_refund_fee

integer

0 to 1000

PayPal Pay Later refund fee, in minor units.

paypal_paylater_dispute_fee

integer

0 to 1000

PayPal Pay Later dispute fee, in minor units.

paypal_paylater_auth_fee

integer

0 to 1000

Fee per PayPal Pay Later authorization, in minor units.

paypal_paylater_auth_void_fee

integer

0 to 1000

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

interchange_plus

boolean

When enabled, Interchange Plus fees (Interchange, Dues, Fees, and Assessments) are passed through to the merchant in addition to the card volume rate. This option is only available for merchants using Monthly Gross billing.

currency_code

string

enum

required

length between 3 and 3

Three-letter ISO currency code, in uppercase. Currently, only USD is supported.

Allowed:

Headers

Rainforest-Api-Version

string

enum

Defaults to 2024-10-16

Allowed:

Responses

200OK

400Bad request, check for validation errors.

401Authorization missing or invalid.

403Authorization insufficient for requested action.

404Resource not found.

5XXUnexpected error.