portalUrls

Get a list of portal urls

Requires the PORTAL_URL.VIEW permission.

get/v{version}/portal-urls

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/portal-urls
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

customer_idstring

Filter based of customer ID

pricing_plan_subscription_idstring

Filter based of pricing plan subscription ID

typestring

Filter portal urls based on the type

statusstring

Filter portal urls based on the status

expiredstring

Filter portal urls based on whether expires_at has passed (true or false). A CLOSED link never counts as expired.

checkout_session.statusstring

Filter checkout session portal urls based on the status of the session

limitinteger

The amount of records shown in the list

pageinteger

The page which is going to be shown

Headers

x-platform-idstring

Platform ID

Response

OK

pageinteger nullable
limitinteger nullable
total_number_of_pagesinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.