Storefront billing portals

Use these operations to access Storefront billing portals.

Storefront operations interact directly with the customer, and provide the customer with access to their own data.

To use Storefront operations, the customer must be issued a JWT with limited permissions. For more information, see Create a session with username and password and Exchange an authentication token. Storefront operations are intended to be used directly from an untrusted browser.

Operations

Retrieve a billing portal

Request

Retrieve a billing portal with a specified slug.

Path
slugstring, <= 100 characters^[@~\-\.\w]+$required

Resource slug.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/storefront/billing-portals/{slug}'

Responses

Billing portal retrieved.

Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the billing portal.

Example:"bill_prt_0YV7K5TYV5D1P9ZNKDT39KZC3C"
tokenstringread-only

Session token for authentication in the billing portal.

slugstring, [ 5 .. 100 ] charactersrequired

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

websiteIdstring, <= 50 characters(WebsiteId)required

ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

Example:"web_0YV7DE4Z26DQSA1AC92FBJ7SEG"
featuresobject

Features that can be enabled for the billing portal.

customizationobject

Visual customization options for the billing portal.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "bill_prt_0YV7K5TYV5D1P9ZNKDT39KZC3C",
  "token": "string",
  "slug": "string",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "features": {
    "authenticateWithPassword": true,
    "orderCancel": true,
    "orderAddressEdit": true,
    "paymentInstrumentAdd": true,
    "paymentInstrumentUpdate": true,
    "paymentInstrumentDeactivate": true
  },
  "customization": {
    "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "colors": { … },
    "links": { … }
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}