Initiate Mandate Setup

POST /tenants/{tenant}/subscription/billing/mandate-setup

Starts a GoCardless Direct Debit mandate setup. Returns a URL to redirect the user to for authorisation. If setup was already initiated in the last few minutes, returns the existing pending flow's URL instead of creating a new one.

Requires: Admin on Billing.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

{
  "successRedirectUrl": "string"
}

Responses

401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json
404 Not Found