• Billing API

Onboarding Link

post

Create a new onboarding link

This endpoint creates a new onboarding link
This action is not enabled by default. You must request additional permissions to perform this action.

typestring

The type of onboarding link (EXTERNAL_ONBOARDING)

Enum
  • EXTERNAL_ONBOARDING
returnUrlstring

The URL to redirect after onboarding

refreshUrlstring

The URL to refresh during onboarding.

networkstring

The network associated with the onboarding link.

Responses

Request examples

{
  "type": "EXTERNAL_ONBOARDING",
  "returnUrl": "string",
  "refreshUrl": "string",
  "network": "string"
}

Response examples

OK

{
  "data": {
    "url": "string",
    "refreshUrl": "string",
    "returnUrl": "string",
    "type": "EXTERNAL_ONBOARDING",
    "network": "string"
  }
}

Was this page helpful?