GET
/v1/billing_portal/configurationsList portal configurations
Lists customer portal configurations. Filter the results by active or is_default, and use starting_after or ending_before with limit to paginate the configurations.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
activebooleanoptional
Filters configurations by active status when set to true or false.
ending_beforestringoptional
A cursor identifying an object before which to retrieve the previous page of configurations.
expandarray<string>optional
Fields to expand in the response.
is_defaultbooleanoptional
Filters configurations by whether they are the default when set to true or false.
limitintegeroptional
The number of configurations to return. Must be between 1 and 100; defaults to 10 when omitted.
starting_afterstringoptional
A cursor identifying an object after which to retrieve the next page of configurations.
200Returns a list object containing customer portal configurations, a pagination indicator, the list object type, and the access URL.
dataarray<CustomerPortalConfiguration>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultReturns an error object containing details about the failed request.
errorobjectrequired
Error handling
limit must be between 1 and 100 when supplied. Use starting_after or ending_before as object-ID cursors, and provide active and is_default as boolean filters when filtering the list.