logo

Billing Portals

Customer billing portals can be configured here. You can customize various options that appear on your billing portals.

Retrieve a billing portal

Retrieve a billing portal with a specified slug.

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

The resource slug.

Responses
200

Billing portal was retrieved successfully.

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

The resource ID. Defaults to UUID v4.

slug
required
string [ 5 .. 100 ] characters

The url path segment that will be appended to the billing portal url (e.g. https://rebilly.com/billing-portal/{slug}) to make it human-readable and simple.

id
string <= 50 characters

The resource ID. Defaults to UUID v4.

object

Various features that can be enabled for the billing portal.

authenticateWithPassword
boolean
Default: true

Enable or disable a customer ability to authenticate with a password.

orderCancel
boolean
Default: true

Enable or disable a customer ability to cancel an order.

orderAddressEdit
boolean
Default: true

Enable or disable a customer ability to change an order address.

paymentInstrumentAdd
boolean
Default: true

Enable or disable a customer ability to add a new payment instrument.

paymentInstrumentUpdate
boolean
Default: true

Enable or disable a customer ability to update their payment instruments.

paymentInstrumentDeactivate
boolean
Default: true

Enable or disable a customer ability to disable their payment instruments.

object

Visual customization options for the billing portal.

logoId
string <= 50 characters

The resource ID. Defaults to UUID v4.

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

Various urls that appear on the billing portal.

refundPolicy
string <url>

The url to the website refund policy.

privacyPolicy
string <url>

The url to the website privacy policy.

termsOfService
string <url>

The url to the website terms of service.

createdTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

updatedTime
string <date-time>

Read-only timestamp, automatically assigned on back-end.

token
string

The session's token used for authentication.

Array of SelfLink (object) or LogoUrlLink (object) non-empty

The links related to resource.

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

The link type.

Value: "self"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/billing-portals/{slug}
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/storefront/billing-portals/{slug}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "slug": "string",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "features": {
    },
  • "customization": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "_links": [
    ]
}
➔ Next to Email verification