curl --request GET \
--url https://partner.app.com/einvoicing/activations?mode=companies \
--header 'Content-Type: application/json' \
--header 'Authorization: {"api_key": … }'{
"business_entities": [
{
"id": "595e13fd-68b0-40c2-ade3-9780ce339d97",
"display_name": "Acme BE"
},
{
"id": "a3f7b451-29f0-42e0-8e4d-927c0ff19de7",
"display_name": "Beta GmbH"
}
]
}Retrieve a list of Activations.
Retrieves either:
- A list of country-level e-invoicing activations configured at the connected e-invoicing provider, or
- A list of business entities configured at the provider, depending on the query parameters used.
Each activation represents the provider’s capability to support e-invoicing in a specific country and model for a given business entity.
Optional transaction and document type fields
On each country_activation, einvoicing_type and supported_document_types are optional:
- Include them only when provider configuration in Chargebee needs explicit transaction-type (for example B2B / B2C / B2G) and/or document-type steps for that country and model (for example model → transaction type → document type). When present and non-empty, Chargebee shows those choices in the e-invoice configuration section.
- Omit them (or return an empty
supported_document_typesarray) when the activation is a simple country → model mapping and both invoices and credit notes should be sent under that model without further selection in Chargebee.
Business Entity Concept
In Chargebee, a business entity represents a business unit or brand under the merchant’s organization. Refer here for more details. In this SPI, a business entity corresponds to the closest equivalent in the provider’s system (for example, a company, or tenant).
Modes of Operation
-
When called without parameters, returns all activations across business entities (if supported by the provider).
-
When called with
business_entity_id, returns activations for that specific business entity. -
When called with
mode=business_entities, returns a list of business entities that are active or configured in the provider.
This endpoint enables Chargebee to:
- Identify e-invoicing capabilities available for activation.
- Fetch business entity lists for provider configuration workflows.
- Retrieve activation details filtered by a specific business entity during country-level setup.
Example use cases
-
During integration setup:
GET /einvoicing/activations?mode=business_entities -
During country configuration:
GET /einvoicing/activations?business_entity_id=<provider_entity_id>
curl --request GET \
--url https://partner.app.com/einvoicing/activations?mode=companies \
--header 'Content-Type: application/json' \
--header 'Authorization: {"api_key": … }'{
"business_entities": [
{
"id": "595e13fd-68b0-40c2-ade3-9780ce339d97",
"display_name": "Acme BE"
},
{
"id": "a3f7b451-29f0-42e0-8e4d-927c0ff19de7",
"display_name": "Beta GmbH"
}
]
}Authorizations
Query Parameters
Filters activations for a specific business entity.
In Chargebee, a business entity represents a business unit or brand under the merchant's organization. In this SPI, the
business_entity_id refers to the corresponding identifier in the
e-invoicing provider’s system (for example, a company or tenant ID).
When provided, the adapter must return only the activations that belong to the specified business entity.
Filters activations by country.
The value must be a two-letter ISO 3166-1 alpha-2 country code
(for example, DE, FR, IT).
When provided, the adapter must return only the activations that are applicable for the specified country.
This parameter is typically used during country-level e-invoicing configuration to determine whether a provider supports e-invoicing for a given country and business ent
2Optional mode for controlling the response type:
business_entities: Returns list of Business Entities.activations(default): Returns list of activations.
business_entities, activations Response
A list of activations
- Option 1
- Option 2
Show child attributes
Show child attributes