Configurations

API Version

Product Catalog

Library

This resource returns your domain and product catalog version details - Product Catalog 1.0(v1) and Product Catalog 2.0(v2).

Sample configuration [ JSON ]

{
    "configurations": [
        {
            "domain": "yourapp",
            "object": "configuration",
            "product_catalog_version": "v1"
        }
    ]
}

domain

optional, string, max chars=50
The Chargebee site for which the information has been requested. It is the same as the value of {site} provided as a path parameter.

product_catalog_version

optional, enumerated string
The Product Catalog version of the site

Possible values are

v1Indicates Product Catalog 1.0v2Indicates Product Catalog 2.0

chargebee_response_schema_type

optional, enumerated string
Specifies the API response format based on the product catalog version of the site.

Possible values are

plans_addonsThe response format follows product catalog 1.0, using plans and addons.itemsThe response format follows product catalog 2.0, using items.compatThe response supports both Product Catalog 1.0 and 2.0 formats. It is applicable only to sites that have been automatically upgraded to Product Catalog 2.0.

Returns a list of your domain and product catalog version details.

Sample Request

Only for Java

copy full code

Click to Copy

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

copy

Click to Copy

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

Sample Response [ JSON ]

{
    "configurations": [
        {
            "domain": "yourapp",
            "object": "configuration",
            "product_catalog_version": "v1"
        },
        {..}
    ]
}

URL Format GET

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

configurations

always returned
Resource object representing configurations

Sample configuration [ JSON ]

API Index URL GET

Model Class

Configuration attributes

Consent Fields for Configuration

Custom Fields for Configuration

List site configurations ¶

Notes

Sample Response [ JSON ]

URL Format GET

Method

Input Parameters

Filter Params

For operator usages, see the Pagination and Filtering section.

Returns

Sample admin console URL