Retrieve a billing portal

Retrieve a billing portal with a specified slug.

SecuritySecretApiKey or JWT
Request
path Parameters
slug
required
string <= 100 characters ^[@~\-\.\w]+$

Resource slug.

Responses
200

Billing portal retrieved.

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

ID of the website. A website is where an organization obtains a customer. 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}.

id
string <= 50 characters

ID of the billing portal.

token
string

Session's token used for authentication.

object

Features that can be enabled for the billing portal.

authenticateWithPassword
boolean
Default: true

Specifies if a customer can authenticate with a password.

orderCancel
boolean
Default: true

Specifies if a customer can cancel an order.

orderAddressEdit
boolean
Default: true

Specifies if a customer can change an order address.

paymentInstrumentAdd
boolean
Default: true

Specifies if a customer can add a new payment instrument.

paymentInstrumentUpdate
boolean
Default: true

Specifies if a customer can update their payment instruments.

paymentInstrumentDeactivate
boolean
Default: true

Specifies if 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.

primary
string <= 6 characters
Default: "0044d4"

Primary color for the billing portal in hexadecimal format.

secondary
string <= 6 characters
Default: "ffffff"

Secondary color for the billing portal in hexadecimal format.

object

URLs that are displayed in the billing portal.

refundPolicy
string <url>

Website refund policy URL.

privacyPolicy
string <url>

Website privacy policy URL.

termsOfService
string <url>

Website terms of service URL.

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.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "logoUrl"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/storefront/billing-portals/{slug}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "token": "string",
  • "slug": "string",
  • "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  • "features": {
    },
  • "customization": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}