PUT /billing-portals/{id}

Creates or updates (upserts) a billing portal with a specified ID.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the billing portal.
`_links[]`	Array	No	Related links.
`_links[].href`	String	No	Link URL.
`_links[].rel`	String	No	Type of link. Valid values: `"self"`
`customDomain`	String	No	Custom domain for the billing portal. The default domain is: `portal.secure-payments.app`.
`name`	String	Yes	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.
`updatedTime`	String	No	Date and time when the resource is updated. This value is set automatically when the resource is updated.
`slug`	String	Yes	Path segment that is appended to the billing portal URL to help make it human-readable. Example: `https://example.com/billing-portal/{slug}`.
`createdTime`	String	No	Date and time when the resource is created. This value is set automatically when the resource is created.
`status`	String	No	Status of the billing portal. If the status is `inactive`, the billing portal URL results in a 404 error. Valid values: `"inactive"` `"active"` Default value: "active"
`features`	Object	No	Features that can be enabled for the billing portal.
`features.paymentInstrumentDeactivate`	Boolean	No	Specifies if a customer can disable their payment instruments. Default value: true
`features.orderCancel`	Boolean	No	Specifies if a customer can cancel an order. Default value: true
`features.paymentInstrumentUpdate`	Boolean	No	Specifies if a customer can update their payment instruments. Default value: true
`features.orderAddressEdit`	Boolean	No	Specifies if a customer can change an order address. Default value: true
`features.authenticateWithPassword`	Boolean	No	Specifies if a customer can authenticate with a password. Default value: true
`features.paymentInstrumentAdd`	Boolean	No	Specifies if a customer can add a new payment instrument. Default value: true
`customization`	Object	No	Visual customization options for the billing portal.
`customization.logoId`	String	No	File ID of the billing portal logo.
`customization.colors`	Object	No	Various colors used in the billing portal.
`customization.colors.primary`	String	No	Primary color for the billing portal in hexadecimal format. Default value: "0044d4"
`customization.colors.secondary`	String	No	Secondary color for the billing portal in hexadecimal format. Default value: "ffffff"
`customization.links`	Object	No	URLs that are displayed in the billing portal.
`customization.links.termsOfService`	String	No	Website terms of service URL.
`customization.links.privacyPolicy`	String	No	Website privacy policy URL.
`customization.links.refundPolicy`	String	No	Website refund policy URL.
`websiteId`	String	Yes	ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.