Versions Compared

Old Version 1

changes.mady.by.user John M

Saved on

compared with

New Version Current

changes.mady.by.user John M

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

configuration resource

The configuration resource provides information on the version of the Product Catalog for a specific Chargebee site.

Note

Unavailble in SDKs

This resource and endpoint is not available in the client libraries.

Attributes

Name

Description

domain

Status
colourPurple
titleString

The subdomain of the Chargebee site for which the information has been requested, this value is identical to the {site} parameter provided in the path.

product_catalog_version

Status
colourPurple
titleENUM

The Product Catalog version of the site. Possible values are:

  • v1

  • v2

ON THIS PAGE

Table of Contents

Endpoint

List site configurations

Status
colourGreen
titleGET
https://{site}.chargebee.com/api/v2/configurations

This API returns the configurations resource for the Chargebee site specified.

Path parameter

Name

Description

{site}

Status
colourPurple
titleString

The subdomain of the Chargebee site for which the information is requested. For example, if your Chargebee site is https://acme-test.chargebee.com, the value that should be passed is acme-test.

Response

A JSON array containing a single object with the configuration resource for the specified Chargebee site.

Code samples

Request

Code Block
languagebash
curl https://{site}.chargebee.com/api/v2/configurations 
  -u {site_api_key}:

Response

Code Block
languagejson
{
	"configurations": [{
		"domain": "mannar-test",
		"product_catalog_version": "v2",
		"object":"configuration"
	}]
}