Skip to content

Get the Paddle customer portal URL

GET
/api/billing/portal

Owner-only. Returns a one-time URL that opens the Paddle billing portal.

Portal URL

object
ok
required
boolean
data
required
object
portalUrl
required
string format: uri

No billing account on file

object
ok
required
boolean
error
required
string
code
string

Not the band owner / not in band

object
ok
required
boolean
error
required
string
code
string

Failed to get portal URL

object
ok
required
boolean
error
required
string
code
string