Configurations API

configuration resource

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

Unavailble in SDKs

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

Attributes

Name

Description

domain

String

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

ENUM

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

  • v1

  • v2

Endpoint

List site configurations

GET https://{site}.chargebee.com/api/v2/configurations

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

Path parameter

Name

Description

Name

Description

{site}

String

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

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

Response

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