Settings
API Version
Product Catalog
Library

Configurations

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" } ] }

API Index URL GET

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

Model Class

 

      Configuration attributes
      
 
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
 
 Show all values[+]
 
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.
 
 Show all values[+]
 
 
Event types
 

      This is a list of the event types we currently support. We will continue
      to add more events moving forward. All events follow a uniform pattern -
      <resource>_<event_name>. The resources that will be
      present in the event content are provided beneath each event type's
      description.
    
 
Note: If consolidated invoicing is enabled, the
      attributes invoice.subscription_id and
      credit_note.subscription_id should not be used
      (as it will not be present if the invoice / credit note has lines from
      multiple subscriptions). Instead to know the related subscriptions,
      their line_items' subscription_id attribute should be referred.
    
 
 
domain 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 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
 
 Show all values[+]
chargebee_response_schema_type 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.
 
 Show all values[+]
 
 
Consent Fields for Configuration
 
 
Custom Fields for Configuration
 
  

      List site configurations
      
  
 
Returns a list of your domain and product catalog version details.
  
Notes
 
 

        Sample Request
      
 

  Try in API Explorer

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

      copy
      
Click to Copy
 
 

    Sample Response [ JSON ]
 
Show more...
 
{
    "configurations": [
        {
            "domain": "yourapp",
            "object": "configuration",
            "product_catalog_version": "v1"
        },
        {..}
    ]
}
 

      URL Format
      GET
 

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

      always returned 
 Resource object representing configurations
 
Sample admin console URL
 

      https://{site}.chargebee.com/admin-console/configurations/123x