Become a Paddle partner
Join the Paddle partner program to read this content. You'll also get access to our partner API and agent tooling. Let us know a few details about your business to get started. Already a partner? Log in to view this page.
POST
/accounts Creates a new account.
If successful, your response includes a copy of the new account entity.
Request body
userobjectrequired
User information for the seller's primary contact.
first_namestringrequired
First name of the seller's primary contact.
Length: 1–50
last_namestringrequired
Last name of the seller's primary contact.
Length: 1–50
emailstring (email)required
Example:
test@paddle.comEmail address for the seller's primary contact. Must be unique across all sellers and vendor users.
Length: 1–320
marketing_consentboolean
Default:
falseWhether this seller opted-in to marketing from Paddle.
passwordstring (password) | null
Password for the seller's primary contact.
Max length: 128
businessobjectrequired
Business information for the seller.
namestringrequired
Legal name of the business.
Length: 1–300
registration_numberstring | null
Company registration number for the business.
Max length: 50
stock_ticker_symbolstring | null
Stock ticker symbol for the business. Required if business type is 'public'.
Length: 1–10
typestring | null
Example:
individualType of business entity.
Values
individualSole trader or self-employed person.privatePrivate company.publicPublic company.
addressobject | null
Business address information.
first_linestring | null
First line of the business address.
Max length: 255
postal_codestring | null
Postal code of the business address.
Max length: 30
country_codestring | null
Supported two-letter ISO 3166-1 alpha-2 country code for this address.
Values
ADAndorraAEUnited Arab EmiratesAGAntigua and BarbudaAIAnguillaALAlbania
+ Show all values− Hide values
AMArmeniaAOAngolaARArgentinaASAmerican SamoaATAustriaAUAustraliaAWArubaAXÃ…land IslandsAZAzerbaijanBABosnia and HerzegovinaBBBarbadosBDBangladeshBEBelgiumBFBurkina FasoBGBulgariaBHBahrainBIBurundiBJBeninBLSaint BarthélemyBMBermudaBNBruneiBOBoliviaBQCaribbean Netherlands (Bonaire, Sint Eustatius, and Saba)BRBrazilBSBahamasBTBhutanBVBouvet IslandBWBotswanaBZBelizeCACanadaCCCocos IslandsCGRepublic of CongoCHSwitzerlandCICôte d'Ivoire (Ivory Coast)CKCook IslandsCLChileCMCameroonCNChinaCOColombiaCRCosta RicaCVCape VerdeCWCuraçaoCXChristmas IslandCYCyprusCZCzechia (Czech Republic)DEGermanyDJDjiboutiDKDenmarkDMDominicaDODominican RepublicDZAlgeriaECEcuadorEEEstoniaEGEgyptEHWestern SaharaEREritreaESSpainETEthiopiaFIFinlandFJFijiFKFalkland IslandsFMMicronesiaFOFaroe IslandsFRFranceGAGabonGBUnited KingdomGDGrenadaGEGeorgiaGFFrench GuianaGGGuernseyGHGhanaGIGibraltarGLGreenlandGMGambiaGNGuineaGPGuadeloupeGQEquatorial GuineaGRGreeceGSSouth Georgia and the South Sandwich IslandsGTGuatemalaGUGuamGWGuinea-BissauGYGuyanaHKHong KongHMHeard Island and McDonald IslandsHNHondurasHRCroatiaHUHungaryIDIndonesiaIEIrelandILIsraelIMIsle of ManINIndiaIOBritish Indian Ocean TerritoryIQIraqISIcelandITItalyJEJerseyJMJamaicaJOJordanJPJapanKEKenyaKGKyrgyzstanKHCambodiaKIKiribatiKMComorosKNSaint Kitts and NevisKRSouth KoreaKWKuwaitKYCayman IslandsKZKazakhstanLALao People's Democratic Republic (Laos)LBLebanonLCSaint LuciaLILiechtensteinLKSri LankaLRLiberiaLSLesothoLTLithuaniaLULuxembourgLVLatviaMAMoroccoMCMonacoMDMoldovaMEMontenegroMFSaint MartinMGMadagascarMHMarshall IslandsMKMacedoniaMNMongoliaMOMacaoMPNorthern Mariana IslandsMQMartiniqueMRMauritaniaMSMontserratMTMaltaMUMauritiusMVMaldivesMWMalawiMXMexicoMYMalaysiaMZMozambiqueNANamibiaNCNew CaledoniaNENigerNFNorfolk IslandNGNigeriaNLNetherlandsNONorwayNPNepalNRNauruNUNiueNZNew ZealandOMOmanPAPanamaPEPeruPFFrench PolynesiaPGPapua New GuineaPHPhilippinesPKPakistanPLPolandPMSaint Pierre and MiquelonPNPitcairnPRPuerto RicoPSPalestinian territoriesPTPortugalPWPalauPYParaguayQAQatarREReunionRORomaniaRSRepublic of SerbiaRWRwandaSASaudi ArabiaSBSolomon IslandsSCSeychellesSESwedenSGSingaporeSHSaint HelenaSISloveniaSJSvalbard and Jan MayenSKSlovakiaSLSierra LeoneSMSan MarinoSNSenegalSRSurinameSTSão Tomé and PrÃncipeSVEl SalvadorSXSint MaartenSZSwazilandTCTurks and Caicos IslandsTDChadTFFrench Southern and Antarctic LandsTGTogoTHThailandTJTajikistanTKTokelauTLTimor-LesteTMTurkmenistanTNTunisiaTOTongaTRTurkeyTTTrinidad and TobagoTVTuvaluTWTaiwanTZTanzaniaUAUkraineUGUgandaUMUnited States Minor Outlying IslandsUSUnited StatesUYUruguayUZUzbekistanVAHoly See (Vatican City)VCSaint Vincent and the GrenadinesVGBritish Virgin IslandsVIU.S. Virgin IslandsVNVietnamVUVanuatuWFWallis and FutunaWSSamoaXKKosovoYTMayotteZASouth AfricaZMZambia
display_namestring | null
Display name for buyer-facing surfaces (e.g. receipts). Typically the app or product name.
Allowed characters: Unicode letters, numbers, combining marks, whitespace, and common punctuation
(- _ . , & ' " ! ( ) [ ] { } © ® ™ /). Characters outside this set are rejected.
Max length: 100
product_categoriesarrayrequired
Product categories that the seller will be selling.
Items: 1–20, unique
Values
digital_products_or_saasSeller is selling digital products or SaaS.appsSeller is selling apps.human_servicesSeller is providing human services.cloud_hostingSeller is providing cloud hosting.financial_servicesSeller is providing financial services.
+ Show all values− Hide values
physical_productsSeller is selling physical productsgambling_productsSeller is selling gambling productsmarketplace_for_sellersSeller is providing a marketplace for other sellers
annual_revenuestring | null
Example:
0_100kEstimated annual revenue of the seller.
Values
not_yet_liveNot yet live, no annual revenue.0_100k100k_500k500k_3m3m_10m
+ Show all values− Hide values
10m_plus
accepted_terms_of_servicebooleanrequired
Whether this seller accepted the Paddle terms of service. Must be true.
external_idstring | null
External identifier of this account in the partner.
Max length: 255
Response (201)
dataobjectrequired
Represents an account entity.
idstringrequired
Seller ID that this entity relates to.
Pattern:
^[a-z0-9_]+$display_namestring | nullrequired
Name shown to customers on invoices, receipts, and in the Paddle customer portal.
Max length: 100
created_atstring (date-time)required
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
updated_atstring (date-time)required
Example:
2024-10-13T07:20:50.52ZRFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
api_keystringrequired
API key for this account.
user_api_keystringrequired
User API key for this account's primary contact.
userobjectrequired
User details for the account's primary contact.
idstringrequired
Example:
usr_01kn2016cfw410ahs0c02nexmnUser Paddle ID that this entity relates to.
Pattern:
^usr_[a-z\d]{26}$first_namestringrequired
First name for this seller.
Max length: 1024
last_namestringrequired
Last name for this seller.
Max length: 1024
emailstring (email)required
Email address for this seller.
marketing_consentbooleanrequired
Default:
falseWhether this seller opted-in to marketing from Paddle.
businessobjectrequired
Business information for this account.
namestringrequired
Name of the business.
Max length: 300
typestring | nullrequired
Example:
individualType of business entity.
Values
individualSole trader or self-employed person.privatePrivate company.publicPublic company.
addressobject | nullrequired
Business address information.
first_linestring | nullrequired
Example:
3811 Ditmars Blvd # 1071First line of this address.
Max length: 1024
second_linestring | nullrequired
Second line of this address.
Max length: 1024
citystring | nullrequired
Example:
AstoriaCity of this address.
Max length: 200
postal_codestring | nullrequired
Example:
11105-1803ZIP or postal code of this address. Required for some countries.
Max length: 200
regionstring | nullrequired
Example:
NYState, county, or region of this address.
Max length: 200
country_codenullrequired
Supported two-letter ISO 3166-1 alpha-2 country code for this address.
string
Two-letter ISO 3166-1 alpha-2 representation of a supported country.
Values
ADAndorraAEUnited Arab EmiratesAGAntigua and BarbudaAIAnguillaALAlbania
+ Show all values− Hide values
AMArmeniaAOAngolaARArgentinaASAmerican SamoaATAustriaAUAustraliaAWArubaAXÃ…land IslandsAZAzerbaijanBABosnia and HerzegovinaBBBarbadosBDBangladeshBEBelgiumBFBurkina FasoBGBulgariaBHBahrainBIBurundiBJBeninBLSaint BarthélemyBMBermudaBNBruneiBOBoliviaBQCaribbean Netherlands (Bonaire, Sint Eustatius, and Saba)BRBrazilBSBahamasBTBhutanBVBouvet IslandBWBotswanaBZBelizeCACanadaCCCocos IslandsCGRepublic of CongoCHSwitzerlandCICôte d'Ivoire (Ivory Coast)CKCook IslandsCLChileCMCameroonCNChinaCOColombiaCRCosta RicaCVCape VerdeCWCuraçaoCXChristmas IslandCYCyprusCZCzechia (Czech Republic)DEGermanyDJDjiboutiDKDenmarkDMDominicaDODominican RepublicDZAlgeriaECEcuadorEEEstoniaEGEgyptEHWestern SaharaEREritreaESSpainETEthiopiaFIFinlandFJFijiFKFalkland IslandsFMMicronesiaFOFaroe IslandsFRFranceGAGabonGBUnited KingdomGDGrenadaGEGeorgiaGFFrench GuianaGGGuernseyGHGhanaGIGibraltarGLGreenlandGMGambiaGNGuineaGPGuadeloupeGQEquatorial GuineaGRGreeceGSSouth Georgia and the South Sandwich IslandsGTGuatemalaGUGuamGWGuinea-BissauGYGuyanaHKHong KongHMHeard Island and McDonald IslandsHNHondurasHRCroatiaHUHungaryIDIndonesiaIEIrelandILIsraelIMIsle of ManINIndiaIOBritish Indian Ocean TerritoryIQIraqISIcelandITItalyJEJerseyJMJamaicaJOJordanJPJapanKEKenyaKGKyrgyzstanKHCambodiaKIKiribatiKMComorosKNSaint Kitts and NevisKRSouth KoreaKWKuwaitKYCayman IslandsKZKazakhstanLALao People's Democratic Republic (Laos)LBLebanonLCSaint LuciaLILiechtensteinLKSri LankaLRLiberiaLSLesothoLTLithuaniaLULuxembourgLVLatviaMAMoroccoMCMonacoMDMoldovaMEMontenegroMFSaint MartinMGMadagascarMHMarshall IslandsMKMacedoniaMNMongoliaMOMacaoMPNorthern Mariana IslandsMQMartiniqueMRMauritaniaMSMontserratMTMaltaMUMauritiusMVMaldivesMWMalawiMXMexicoMYMalaysiaMZMozambiqueNANamibiaNCNew CaledoniaNENigerNFNorfolk IslandNGNigeriaNLNetherlandsNONorwayNPNepalNRNauruNUNiueNZNew ZealandOMOmanPAPanamaPEPeruPFFrench PolynesiaPGPapua New GuineaPHPhilippinesPKPakistanPLPolandPMSaint Pierre and MiquelonPNPitcairnPRPuerto RicoPSPalestinian territoriesPTPortugalPWPalauPYParaguayQAQatarREReunionRORomaniaRSRepublic of SerbiaRWRwandaSASaudi ArabiaSBSolomon IslandsSCSeychellesSESwedenSGSingaporeSHSaint HelenaSISloveniaSJSvalbard and Jan MayenSKSlovakiaSLSierra LeoneSMSan MarinoSNSenegalSRSurinameSTSão Tomé and PrÃncipeSVEl SalvadorSXSint MaartenSZSwazilandTCTurks and Caicos IslandsTDChadTFFrench Southern and Antarctic LandsTGTogoTHThailandTJTajikistanTKTokelauTLTimor-LesteTMTurkmenistanTNTunisiaTOTongaTRTurkeyTTTrinidad and TobagoTVTuvaluTWTaiwanTZTanzaniaUAUkraineUGUgandaUMUnited States Minor Outlying IslandsUSUnited StatesUYUruguayUZUzbekistanVAHoly See (Vatican City)VCSaint Vincent and the GrenadinesVGBritish Virgin IslandsVIU.S. Virgin IslandsVNVietnamVUVanuatuWFWallis and FutunaWSSamoaXKKosovoYTMayotteZASouth AfricaZMZambia
registration_numberstring | nullrequired
Company number for the business.
Max length: 50
stock_ticker_symbolstring | nullrequired
Stock ticker symbol for the business.
Length: 1–10
metaobjectrequired
Information about this response.
request_idstringrequired
Example:
b15ec92e-8688-40d4-a04d-f44cbec93355Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
{ "user": { "first_name": "Jo", "last_name": "Brown", "email": "jo@example.com", "marketing_consent": true }, "business": { "name": "Example Studios Ltd", "type": "private", "registration_number": "12345678", "address": { "first_line": "3811 Ditmars Blvd", "city": "Astoria", "postal_code": "11105", "region": "NY", "country_code": "US" } }, "display_name": "Example Studios", "product_categories": [ "digital_products_or_saas" ], "annual_revenue": "0_100k", "accepted_terms_of_service": true, "external_id": "partner-acct-9f2b"}{ "data": { "id": "158261", "display_name": "Example Studios", "created_at": "2024-04-11T15:57:24.813Z", "updated_at": "2024-04-11T15:57:24.813Z", "api_key": "apikey_01hv6y1jedq4p1n0yqn5ba3ky4", "user_api_key": "userapikey_01hv6y1jedq4p1n0yqn5ba3ky4", "user": { "id": "usr_01kn2016cfw410ahs0c02nexmn", "first_name": "Jo", "last_name": "Brown", "email": "jo@example.com", "marketing_consent": true }, "business": { "name": "Example Studios Ltd", "type": "private", "registration_number": "12345678", "stock_ticker_symbol": null, "address": { "first_line": "3811 Ditmars Blvd", "second_line": null, "city": "Astoria", "postal_code": "11105", "region": "NY", "country_code": "US" } } }, "meta": { "request_id": "9bcdcc29-e180-4055-ad3d-d37e5dc5e56d" }}