Billing Portals

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

Retrieve a list of billing portals

Retrieve a list of billing portals.

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of billing portals was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/billing-portals
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/organizations/unknown/billing-portals?limit=1000&offset=0&sort=string&filter=string&q=string' \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Create a billing portal

Create a billing portal.

Request
Security:
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
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.

websiteId
required
string <= 50 characters

Billing portal website ID.

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

Linked file object ID.

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.

name
required
string

Billing portal name, used for internal display to help you organize your various billing portals. Will not be displayed to your customers.

status
string
Default: "active"

If inactive, the billing portal url will result in a 404.

Enum: "active" "inactive"
Responses
201

Billing portal was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/billing-portals
Request samples
application/json
{
  • "slug": "string",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "features": {
    },
  • "customization": {
    },
  • "name": "string",
  • "status": "active"
}
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",
  • "name": "string",
  • "status": "active",
  • "_links": [
    ]
}

Retrieve a billing portal

Retrieve a billing portal with specified identifier string.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Billing portal was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/billing-portals/{id}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/billing-portals/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -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",
  • "name": "string",
  • "status": "active",
  • "_links": [
    ]
}

Create or update a billing portal

Create or update a billing portal with predefined identifier string.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
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.

websiteId
required
string <= 50 characters

Billing portal website ID.

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

Linked file object ID.

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.

name
required
string

Billing portal name, used for internal display to help you organize your various billing portals. Will not be displayed to your customers.

status
string
Default: "active"

If inactive, the billing portal url will result in a 404.

Enum: "active" "inactive"
Responses
200

Billing portal was updated.

201

Billing portal was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

put/billing-portals/{id}
Request samples
application/json
{
  • "slug": "string",
  • "websiteId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "features": {
    },
  • "customization": {
    },
  • "name": "string",
  • "status": "active"
}
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",
  • "name": "string",
  • "status": "active",
  • "_links": [
    ]
}

Delete a billing portal

Delete a billing portal with predefined identifier string.

Request
Security:
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Billing portal was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

delete/billing-portals/{id}
Request samples
curl -i -X DELETE \
  https://api-sandbox.rebilly.com/organizations/unknown/billing-portals/:id \
  -H 'Organization-Id: 4f6cf35x-2c4y-483z-a0a9-158621f77a21' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}