/
Create a billing portal

Create a billing portal

Request

Creates a billing portal.

Security
SecretApiKey or JWT
Bodyapplication/json
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"
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}.

namestringrequired

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.

customDomainstring or null, <= 255 characters

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

featuresobject

Features that can be enabled for the billing portal.

customizationobject

Visual customization options for the billing portal.

statusstring

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

Default:"active"
Enum:"active""inactive"
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/billing-portals \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
    "slug": "string",
    "name": "string",
    "customDomain": "string",
    "features": {
      "authenticateWithPassword": true,
      "orderCancel": true,
      "orderAddressEdit": true,
      "paymentInstrumentAdd": true,
      "paymentInstrumentUpdate": true,
      "paymentInstrumentDeactivate": true
    },
    "customization": {
      "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
      "colors": {
        "primary": "0044d4",
        "secondary": "ffffff"
      },
      "links": {
        "refundPolicy": "http://example.com",
        "privacyPolicy": "http://example.com",
        "termsOfService": "http://example.com"
      }
    },
    "status": "active"
  }'

Responses

Billing portal created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the billing portal.

Example:"bill_prt_0YV7K5TYV5D1P9ZNKDT39KZC3C"
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"
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}.

namestringrequired

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.

customDomainstring or null, <= 255 characters

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

featuresobject

Features that can be enabled for the billing portal.

customizationobject

Visual customization options for the billing portal.

statusstring

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

Default:"active"
Enum:"active""inactive"
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",
  "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
  "slug": "string",
  "name": "string",
  "customDomain": "string",
  "features": {
    "authenticateWithPassword": true,
    "orderCancel": true,
    "orderAddressEdit": true,
    "paymentInstrumentAdd": true,
    "paymentInstrumentUpdate": true,
    "paymentInstrumentDeactivate": true
  },
  "customization": {
    "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "colors": { … },
    "links": { … }
  },
  "status": "active",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}