Beta Ramps API
Subaccounts

Post Subaccounts

POST
/subaccounts

Authorization

headerAuthorizationBearer <token>

Scope: subaccounts:write

Header Parameters

Idempotency-Key*string

Unique key to make the create idempotent across retries.

Request Body

application/json
  1. body

Create a subaccount. entity_type and name are required. Business-only and individual-only profile fields are rejected with 400 when sent for the wrong entity_type; none of the profile fields are echoed back in the response.

entity_type*string

The kind of subaccount.

Value in"business""individual"
name*string

Legal or full name.

alias?string

Optional display alias.

email?string
Formatemail
phone?string

E.164 phone number.

country?string

ISO 3166-1 alpha-2 country code.

city?string
state?string
address?string
postcode?string
tax_id_number?string
tax_id_type?string

Tax ID type code (see the reference tax-id-types endpoint).

local_id_number?string
local_id_type?string
company_type?string

Business only.

Value in"llc""corporation""partnership""sole_proprietorship""non_profit"
incorporation_date?string

Business only; must be in the past (YYYY-MM-DD).

Formatdate
industry?string

Business only.

describe_business_model?string

Business only.

describe_revenue_sources?string

Business only.

describe_source_funds?string

Individual only.

describe_services_provided?string

Business only.

describe_account_purpose?string

Business only.

describe_clients?string

Business only.

annual_income?string

Decimal string, >= 0.

net_total_assets?string

Decimal string, >= 0.

estimated_processing_volume?string

Decimal string, >= 0.

list_client_territories?string

Business only; free text.

website_url?string
website_platform?string
Value in"shopify""woocommerce""custom"
terms_conditions_url?string

Business only.

privacy_policy_url?string

Business only.

occupation?string

Individual only.

is_intermediary?boolean

Response Body

Idempotent replay: the Idempotency-Key matched an existing subaccount, which is returned unchanged.

application/json
  1. response
id*string

Subaccount ID (prefix sub_).

account_id*string

Owning account ID (prefix acc_).

entity_type*string
Value in"business""individual"
name*string
alias?string
email?string
phone?string
country?string
city?string
state?string
address?string
postcode?string
tax_id_number?string
tax_id_type?string
local_id_number?string
local_id_type?string
is_active*boolean
kyc_status*string
Value in"pending""approved""rejected""expired""info_requested"
kyc_daily_limit?string

Decimal string.

kyc_weekly_limit?string

Decimal string.

kyc_monthly_limit?string

Decimal string.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
inactivated_at?|

Set when the subaccount is inactivated.

Formatdate-time
Example Request
curl -X POST 'https://api.betaramps.com/subaccounts' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "entity_type": "business",  "name": "Acme Payments LLC",  "email": "ops@acmepayments.example",  "phone": "+15125550199",  "country": "US",  "city": "Austin",  "state": "TX",  "address": "100 Congress Ave",  "postcode": "78701",  "tax_id_number": "47-1234567",  "tax_id_type": "ein",  "company_type": "llc",  "incorporation_date": "2019-04-12",  "industry": "software",  "describe_business_model": "SaaS billing platform for online merchants",  "estimated_processing_volume": "250000",  "website_url": "https://acmepayments.example"}'
Example Response
{  "id": "sub_0192f4e3-8a9b-7c6d-5e4f-3a2b1c0d9e8f",  "account_id": "acc_0192f4e0-1a2b-7c3d-8e4f-5a6b7c8d9e01",  "entity_type": "business",  "name": "Acme Payments LLC",  "email": "ops@acmepayments.example",  "phone": "+15125550199",  "country": "US",  "city": "Austin",  "state": "TX",  "address": "100 Congress Ave",  "postcode": "78701",  "tax_id_number": "47-1234567",  "tax_id_type": "ein",  "is_active": true,  "kyc_status": "pending",  "kyc_daily_limit": "500",  "kyc_weekly_limit": "500",  "kyc_monthly_limit": "500",  "created_at": "2026-10-30T12:00:00Z",  "updated_at": "2026-10-30T12:00:00Z"}