Create Stripe onboarding link

POST/v1/servers/{serverId}/payments/connect-account

Create or continue Stripe Connect onboarding for a payments resource.

How to call this endpoint

Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.

Path, query, and header parameters

These parameters control which ACP object the endpoint acts on and how the request is processed.

Path parameters
NameLocationTypeRequiredDescription
serverIdpathstringYesResource ID
Query parameters
None.

Body schema

Content type: application/json · Optional

FieldTypeRequiredDescription
countrystringNoISO 3166-1 alpha-2 country code for Stripe Connect onboarding.
emailstringNo
productDescriptionstringNo

What the API returns

Each response code below includes the documented payload shape for the ACP API.

200Payments onboarding linkapplication/json
FieldTypeRequiredDescription
serverobjectNo
server.idstringNoUnique identifier.
server.userIdstringNoUser ID.
server.projectIdstringNoProject ID.
server.namestringNoHuman-readable name.
server.descriptionstringNoHuman-readable description.
server.kindwebsite | web_app | api | function | auth | agent_runtime | secrets | paymentsNo
server.sourceTypestringNo
server.sourceEnvironmentIdstringNo
server.sourcePathstringNoWorkspace-relative file path.
server.regionstringNo
server.runtimestringNo
server.authModepublic | privateNo
server.serviceUrlstringNo
server.customDomainstringNo
server.cloudRunServiceNamestringNo
server.imageUrlstringNo
server.statusdraft | deploying | deployed | failed | inactiveNoCurrent lifecycle status.
server.lastDeployedAtstringNo
server.metadataobjectNoFree-form metadata object.
server.createdAtstringNoISO 8601 timestamp.
server.updatedAtstringNoISO 8601 timestamp.
paymentsobjectNo
payments.idstringNoUnique identifier.
payments.namestringNoHuman-readable name.
payments.kindpaymentsNo
payments.statusstringNoCurrent lifecycle status.
payments.providerstringNo
payments.modetest | liveNo
payments.stripeAccountIdstringNo
payments.onboardingStatusnot_started | pending | completeNo
payments.chargesEnabledbooleanNo
payments.payoutsEnabledbooleanNo
payments.currencystringNo
payments.totalEarnedCentsintegerNo
payments.totalPaymentCountintegerNo
payments.updatedAtstringNoISO 8601 timestamp.
urlstringNoStripe Connect onboarding URL when a new onboarding link was requested.
Create Stripe onboarding link
Loading...
Response 200
Loading...
See the ACP quickstart and SDK flow