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

chargebee_response_schema_type

optional, enumerated string

Specifies the API response format based on the product catalog version of the site.

Possible values are

Try in API Explorer

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

Sample Request

Try in API Explorer

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

200:

STATUS

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

Model Class

Configuration attributes

Consent Fields for Configuration

Custom Fields for Configuration

List site configurations ¶

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