Retrieve billing portals

Retrieves a list of billing portals.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of billing portals retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
websiteId
required
string (WebsiteId) <= 50 characters

Unique website identifier string. A website is where an organization obtains a customer through a subscription. For more information, see Obtain an organization ID and website ID.

slug
required
string [ 5 .. 100 ] characters

Path segment that is appended to the billing portal URL to help make it human-readable. Example: https://example.com/billing-portal/{slug}.

name
required
string

Billing portal name. This name is for internal use and helps you to organize and differentiate billing portals. This value is not displayed to your customers.

id
string <= 50 characters

Billing portal identifier string.

customDomain
string or null <= 255 characters

Custom domain for the billing portal. The default domain is: portal.secure-payments.app.

object

Features that can be enabled for the billing portal.

authenticateWithPassword
boolean
Default: true

Specifies whether a customer can authenticate with a password.

orderCancel
boolean
Default: true

Specifies whether a customer can cancel an order.

orderAddressEdit
boolean
Default: true

Specifies whether a customer can change an order address.

paymentInstrumentAdd
boolean
Default: true

Specifies whether a customer can add a new payment instrument.

paymentInstrumentUpdate
boolean
Default: true

Specifies whether a customer can update their payment instruments.

paymentInstrumentDeactivate
boolean
Default: true

Specifies whether a customer can disable their payment instruments.

object

Visual customization options for the billing portal.

logoId
string <= 50 characters

ID of the linked file object.

object

Various colors used in the billing portal.

object

URLs that are displayed in the billing portal.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

status
string
Default: "active"

Status of the billing portal. If the status is inactive, the billing portal URL results in a 404 error.

Enum: "active" "inactive"
Array of Self (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/billing-portals
Request samples
Response samples
application/json
[
  • {
    }
]