Chargebee PHP

https://github.com/chargebee/chargebee-php
Admin
Chargebee PHP is the official PHP client library for integrating with Chargebee's subscription and...
Tokens:847,929
Snippets:3,996
Trust Score:9.6
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Usage example with ChargebeeClient

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/chargebee-client.md

Example of instantiating the Chargebee client and using chained accessor calls to create a subscription with items. The result provides subscription and customer objects.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient([
    "site" => "acme",
    "apiKey" => "test_8Z2mFeJY5dL85a5hlyk2U4XY1VKKhZ4Kt",
]);

// chained usage
$result = $chargebee->subscription()->createWithItems("cust_123", [
    "subscription_items" => [["item_price_id" => "Montly-Item", "quantity" => "3"]],
]);
$subscription = $result->subscription;
$customer = $result->customer;
```

--------------------------------

### Install OpenTelemetry packages

Source: https://github.com/chargebee/chargebee-php/blob/master/README.md

Install the OpenTelemetry SDK and OTLP exporter via Composer. Required before using the telemetry adapter.

```sh
composer require open-telemetry/sdk open-telemetry/exporter-otlp
```

--------------------------------

### Subscription API Examples

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/subscription.md

Code examples demonstrating how to create, retrieve, list, and cancel subscriptions using the Chargebee PHP client, including error handling and idempotent cancellation.

```APIDOC
## [POST] /subscriptions

### Description
Creates a subscription for items using the item catalog. This operation is invoked via the `createWithItems` method on the subscription resource.

### Method
POST

### Endpoint
/subscriptions

### Parameters
#### Request Body
- **subscription_items** (array) - Required - List of items to include in the subscription, each with `item_price_id` and `quantity`.

### Request Example
```php
$result = $chargebee->subscription()->createWithItems("cust_123", [
    "subscription_items" => [
        ["item_price_id" => "Montly-Item", "quantity" => "3"],
    ],
]);
```

### Response
#### Success Response (200)
- **subscription** (object) - The created subscription object.
- **customer** (object) - The associated customer object.

#### Response Example
```php
$subscription = $result->subscription;
$customer = $result->customer;
```
```

```APIDOC
## [GET] /subscriptions/:id

### Description
Retrieves a subscription by its ID. This operation is invoked via the `retrieve` method on the subscription resource.

### Method
GET

### Endpoint
/subscriptions/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The subscription ID.

### Request Example
```php
$subscription = $chargebee->subscription()->retrieve("sub_123")->subscription;
```

### Response
#### Success Response (200)
- **subscription** (object) - The subscription object with properties such as `status`.

#### Response Example
```php
echo $subscription->status; // Chargebee\Resources\Subscription\Enums\Status
```
```

```APIDOC
## [GET] /subscriptions

### Description
Lists subscriptions with optional filters. This operation is invoked via the `all` method on the subscription resource.

### Method
GET

### Endpoint
/subscriptions

### Parameters
#### Query Parameters
- **status** (array) - Optional - Filter by status, e.g., `["in" => ["active", "in_trial"]]`.
- **limit** (integer) - Optional - Maximum number of results to return.

### Request Example
```php
$list = $chargebee->subscription()->all(["status" => ["in" => ["active", "in_trial"]], "limit" => 10]);
```

### Response
#### Success Response (200)
- **list** (array) - List of subscription entries, each with a `subscription` object.
- **next_offset** (string) - Pagination cursor for the next `all()` call.

#### Response Example
```php
foreach ($list->list as $entry) {
    echo $entry->subscription->id;
}
echo $list->next_offset;
```
```

```APIDOC
## [POST] /subscriptions/:id/cancel

### Description
Cancels a subscription. This operation is invoked via the `cancel` method on the subscription resource.

### Method
POST

### Endpoint
/subscriptions/:id/cancel

### Parameters
#### Path Parameters
- **id** (string) - Required - The subscription ID.

#### Request Body
- **cancel_option** (string) - Required - The cancellation option, e.g., `"end_of_term"`.

### Request Example
```php
$chargebee->subscription()->cancel("sub_123", ["cancel_option" => "end_of_term"]);
```

### Response
#### Success Response (200)
No specific response fields are documented.

### Error Handling
- **InvalidRequestException** - Thrown for invalid requests, with methods `getApiErrorCode()` and `getParam()`.
- **PaymentException** - Thrown for payment gateway declines, with method `getHttpStatusCode()`.
- **OperationFailedException** - Thrown for operation failures.
- **APIError** - Base exception with method `getJsonObject()`.
```

```APIDOC
## [POST] /subscriptions/:id/cancel (Idempotent)

### Description
Cancels a subscription with an idempotency key for safe retries. This operation is invoked via the `cancel` method with an idempotency header.

### Method
POST

### Endpoint
/subscriptions/:id/cancel

### Parameters
#### Path Parameters
- **id** (string) - Required - The subscription ID.

#### Request Body
- **cancel_option** (string) - Required - The cancellation option, e.g., `"end_of_term"`.

#### Headers
- **chargebee-idempotency-key** (string) - Required - Unique key per logical operation.

### Request Example
```php
$result = $chargebee->subscription()->cancel("sub_123", ["cancel_option" => "end_of_term"], [
    "chargebee-idempotency-key" => "a2c4e6f8-...",
]);
```

### Response
#### Success Response (200)
- **isIdempotencyReplayed** (boolean) - Indicates whether the server replayed a previous identical request.

#### Response Example
```php
echo $result->isIdempotencyReplayed(); // true when server replayed a previous identical request
```
```

--------------------------------

### Install Chargebee PHP SDK via Composer

Source: https://github.com/chargebee/chargebee-php/blob/master/README.md

Use Composer to install the chargebee/chargebee-php package. Requires PHP 8.1 or later.

```bash
composer require chargebee/chargebee-php
```

--------------------------------

### GET /api/v2/addons

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Lists all addons.

```APIDOC
## GET /api/v2/addons

### Description
Lists all addons.

### Method
GET

### Endpoint
/api/v2/addons

```

--------------------------------

### TimeMachine::startAfresh

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Starts a time machine afresh.

```APIDOC
## POST /api/v2/time_machines/{id}/start_afresh

### Description
Starts a time machine afresh.

### Method
POST

### Endpoint
/api/v2/time_machines/{id}/start_afresh

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the time machine.

### Response
#### Success Response (200)
- **time_machine** (object) - The restarted time machine.

#### Response Example
{
  "time_machine": {}
}
```

--------------------------------

### RetryConfig usage example

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/environment.md

Shows how to instantiate RetryConfig with custom values or use setters to modify the configuration.

```php
use Chargebee\RetryConfig;

$retryConfig = new RetryConfig(true, 5, 1000, [500, 502, 503, 504, 429]);
// or via setters:
$retryConfig->setEnabled(true);
$retryConfig->setMaxRetries(5);
```

--------------------------------

### GET /api/v2/orders

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all orders.

```APIDOC
## GET /api/v
```

--------------------------------

### GET /api/v2/meters

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all meters.

```APIDOC
## GET /api/v2/meters

### Description
Retrieves a list of meters.

### Method
GET

### Endpoint
/api/v2/meters

### Parameters
#### Query Parameters
- None documented

### Request Example
(No request body)

### Response
#### Success Response (200)
- **list** (array) - List of meter objects

#### Response Example
{
  "list": []
}
```

--------------------------------

### Export parameter shape example (customers export)

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/export.md

Shows the expected structure for export method parameters, including report_by, fields, filters, and download options. The download type can be 'meta' for metadata or 'data' for raw rows.

```php
// customers export
[
  "report_by" => "chargebee",
  "fields" => ["id", "first_name", "last_name", "email"],
  "filters" => ["created_at" => ["after" => 1700000000], "auto_collection" => ["is" => "on"]],
  "download" => ["type" => "meta", "mime_type" => "application/zip"],  // "data" for raw rows
]
```

--------------------------------

### ChargebeePayloadBuilder fluent usage example

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/payload-encoders.md

Shows the fluent builder pattern for constructing a Chargebee payload. Use this to chain builder methods before calling build(). The example includes environment, HTTP method, URI paths, param encoder, subdomain, JSON keys, headers, params, idempotency flag, and telemetry resource/operation.

```php
ChargebeePayload::builder()
    ->withEnvironment($this->env)
    ->withHttpMethod("post")
    ->withUriPaths(["subscriptions", $id, "cancel"])
    ->withParamEncoder(new URLFormEncoder())
    ->withSubDomain(null)
    ->withJsonKeys($jsonKeys)
    ->withHeaders($headers)
    ->withParams($params)
    ->withIdempotent(true)
    ->withTelemetryResource("subscription")
    ->withTelemetryOperation("cancel")
    ->build();
```

--------------------------------

### Create, retrieve, update, and collect payment for a customer

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/customer.md

Shows the main customer workflow: create with card, retrieve and update, and collect a payment. Uses the ChargebeeClient with site and API key. The create example follows the README pattern with card details.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(["site" => "acme", "apiKey" => "test_..."]);

// create with card (README pattern)
$result = $chargebee->customer()->create([
    "first_name" => "John",
    "last_name" => "Doe",
    "email" => "john@test.com",
    "card" => [
        "first_name" => "Joe", "last_name" => "Doe",
        "number" => "4012888888881881", "expiry_month" => "10",
        "expiry_year" => "29", "cvv" => "231",
    ],
]);
$customer = $result->customer;

// retrieve + update
$customer = $chargebee->customer()->retrieve("cust_123")->customer;
$chargebee->customer()->update("cust_123", ["auto_collection" => "off"]);

// collect a payment
$chargebee->customer()->collectPayment("cust_123", ["amount" => 2500, "payment_initiator" => "customer"]);
```

--------------------------------

### List transactions for a subscription and create authorization

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/transaction.md

Shows how to list transactions for a subscription using the transactionsForSubscription method with type and limit filters, then create an authorization with createAuthorization. The example prints transaction fields and checks the authorization status.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(["site" => "acme", "apiKey" => "test_..."]);

// list transactions for a subscription
$page = $chargebee->transaction()->transactionsForSubscription("sub_123", [
    "type" => ["in" => ["payment", "refund"]],
    "limit" => 20,
]);
foreach ($page->list as $entry) {
    $txn = $entry->transaction;
    echo $txn->id, " ", $txn->amount, " ", $txn->status, " ", $txn->type;
}

// authorize a payment (create_authorization)
$auth = $chargebee->transaction()->createAuthorization([
    "customer_id" => "cust_123",
    "currency_code" => "USD",
    "amount" => 10000,
    "payment_method" => ["type" => "card", "payment_source_id" => "pm_123"],
]);
echo $auth->transaction->status; // "authorized"

// refund
$chargebee->transaction()->refund($auth->transaction->id, ["amount" => 10000]);
```

--------------------------------

### GET /api/v2/webhook_endpoints

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all webhook endpoints.

```APIDOC
## GET /api/v2/webhook_endpoints

### Description
Lists all webhook endpoints.

### Method
GET

### Endpoint
/api/v2/webhook_endpoints

### Response
#### Success Response (200)
Returns a list of webhook endpoints.

#### Response Example
{
  "list": [
    {
      "id": "we_123"
    }
  ]
}
```

--------------------------------

### GET /api/v2/ledger_operations

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all ledger operations.

```APIDOC
## GET /api/v2/ledger_operations

### Description
Retrieves a list of ledger operations.

### Method
GET

### Endpoint
/api/v2/ledger_operations

### Parameters
#### Query Parameters
- None documented

### Request Example
(No request body)

### Response
#### Success Response (200)
- **list** (array) - List of ledger operation objects

#### Response Example
{
  "list": []
}
```

--------------------------------

### GET /api/v2/omnichannel_subscriptions

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all omnichannel subscriptions.

```APIDOC
## GET /api/v2/omnichannel_subscriptions

### Description
Lists all omnichannel subscriptions.

### Method
GET

### Endpoint
/api/v2/omnichannel_subscriptions

### Parameters
#### Query Parameters
- No query parameters documented.

### Request Example
{}

### Response
#### Success Response (200)
- No response fields documented.

#### Response Example
{}
```

--------------------------------

### GET /api/v2/omnichannel_one_time_orders

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all omnichannel one-time orders.

```APIDOC
## GET /api/v2/omnichannel_one_time_orders

### Description
Lists all omnichannel one-time orders.

### Method
GET

### Endpoint
/api/v2/omnichannel_one_time_orders

### Parameters
#### Query Parameters
- No query parameters documented.

### Request Example
{}

### Response
#### Success Response (200)
- No response fields documented.

#### Response Example
{}
```

--------------------------------

### Create usage record with UsageActions::create

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/usage.md

Creates a usage record for a subscription using the usage accessor. The example passes the subscription ID, usage quantity, usage date, and aggregation type. The response object exposes the created usage quantity via the usage property.

```php
$result = $chargebee->usage()->create("sub_123", [
    "usage_quantity" => 42,
    "usage_date" => 1700000000,
    "aggregation_type" => "max",
]);
echo $result->usage->usage_quantity;   // 42
```

--------------------------------

### GET /api/v2/virtual_bank_accounts

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all virtual bank accounts.

```APIDOC
## GET /api/v2/virtual_bank_accounts

### Description
Lists all virtual bank accounts.

### Method
GET

### Endpoint
/api/v2/virtual_bank_accounts

### Response
#### Success Response (200)
Returns a list of virtual bank accounts.

#### Response Example
{
  "list": [
    {
      "id": "vba_123"
    }
  ]
}
```

--------------------------------

### GET /api/v2/ledger_account_balances

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all ledger account balances.

```APIDOC
## GET /api/v2/ledger_account_balances

### Description
Retrieves a list of ledger account balances.

### Method
GET

### Endpoint
/api/v2/ledger_account_balances

### Parameters
#### Query Parameters
- None documented

### Request Example
(No request body)

### Response
#### Success Response (200)
- **list** (array) - List of ledger account balance objects

#### Response Example
{
  "list": []
}
```

--------------------------------

### Build ChargebeePayload with URLFormEncoder

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/payload-encoders.md

Use this snippet to construct a ChargebeePayload for a POST request to cancel a subscription. It sets the URI paths, uses a URLFormEncoder, enables idempotency, and includes telemetry resource and operation. The example shows how to retrieve the HTTP method and serialized parameters.

```php
// Not app-facing; shown to illustrate how actions construct requests.
use Chargebee\ValueObjects\Transporters\ChargebeePayload;
use Chargebee\ValueObjects\Encoders\URLFormEncoder;

$payload = ChargebeePayload::builder()
    ->withEnvironment($env)
    ->withHttpMethod("post")
    ->withUriPaths(["subscriptions", "sub_123", "cancel"])
    ->withParamEncoder(new URLFormEncoder())
    ->withParams(["end_of_term" => true])
    ->withIdempotent(true)
    ->withTelemetryResource("subscription")
    ->withTelemetryOperation("cancel")
    ->build();

$httpMethod = $payload->getHttpMethod();   // "post"
$body       = $payload->getSerializedParameters(); // "end_of_term=true"
```

--------------------------------

### Initialize Chargebee Client (Before vs Now)

Source: https://github.com/chargebee/chargebee-php/wiki/Migration-guide-for-v4

Shows the transition from static Environment configuration to the new ChargebeeClient instance.

```php
use ChargeBee\ChargeBee\Models\Environment;  
Environment::configure("{site}", "{site_api_key}");
```

```php
use Chargebee\ChargebeeClient;
$chargebee = new ChargebeeClient([
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
```

--------------------------------

### GET /api/v2/webhook_endpoints/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Retrieves a webhook endpoint by ID.

```APIDOC
## GET /api/v2/webhook_endpoints/{id}

### Description
Retrieves a webhook endpoint by ID.

### Method
GET

### Endpoint
/api/v2/webhook_endpoints/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The webhook endpoint ID.

### Response
#### Success Response (200)
Returns the webhook endpoint details.

#### Response Example
{
  "id": "we_123",
  "url": "https://example.com/hook"
}
```

--------------------------------

### Create, retrieve, and list subscriptions with Chargebee PHP SDK

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/subscription.md

Shows how to create a subscription with items, retrieve a subscription, and list subscriptions with filters using the Chargebee PHP client. The example uses the 'acme' site and a test API key, and demonstrates the 'createWithItems', 'retrieve', and 'all' methods.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(["site" => "acme", "apiKey" => "test_..."]);

// create a subscription for items (item catalog)
$result = $chargebee->subscription()->createWithItems("cust_123", [
    "subscription_items" => [
        ["item_price_id" => "Montly-Item", "quantity" => "3"],
    ],
]);
$subscription = $result->subscription;
$customer = $result->customer;

// retrieve
$subscription = $chargebee->subscription()->retrieve("sub_123")->subscription;
echo $subscription->status; // Chargebee\Resources\Subscription\Enums\Status

// list with filters (GET query string via ListParamEncoder)
$list = $chargebee->subscription()->all(["status" => ["in" => ["active", "in_trial"]], "limit" => 10]);
foreach ($list->list as $entry) {
    echo $entry->subscription->id;
}
echo $list->next_offset; // pagination cursor for the next all() call
```

--------------------------------

### Injection example

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/http-client.md

Shows three ways to inject an HTTP client into ChargebeeClient: default Guzzle, custom PSR-18 client, and custom factory. PSR-18 send failures surface as ClientExceptionInterface and are retried.

```php
use Chargebee\ChargebeeClient;

// 1) Default (Guzzle):
$chargebee = new ChargebeeClient(["site" => "acme", "apiKey" => "test_..."]);

// 2) Custom PSR-18 client:
use Psr\Http\Client\ClientInterface;  // e.g. symfony/http-client
$chargebee = new ChargebeeClient($options, new MyPsr18Client());

// 3) Custom factory:
use Chargebee\HttpClient\HttpClientFactory;
$chargebee = new ChargebeeClient($options, new MyFactory());
```

--------------------------------

### GET /api/v2/offer_fulfillments/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Retrieves a specific offer fulfillment by its ID.

```APIDOC
## GET /api/v2/offer_fulfillments/{id}

### Description
Retrieves a specific offer fulfillment by its ID.

### Method
GET

### Endpoint
/api/v2/offer_fulfillments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the offer fulfillment.

### Request Example
{}

### Response
#### Success Response (200)
- No response fields documented.

#### Response Example
{}
```

--------------------------------

### Create a new subscription with ChargebeeClient

Source: https://github.com/chargebee/chargebee-php/blob/master/README.md

Initializes the Chargebee client with site and API key, then creates a subscription with subscription items. The result provides access to the created subscription and customer objects.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{your_site}",
    "apiKey" => "{your_apiKey}",
]);

$result = $chargebee->subscription()->createWithItems("customer_id", [
    "subscription_items" => [
        [
            "item_price_id" => "Montly-Item",
            "quantity" => "3",
        ]
    ]
]);
$subscription = $result->subscription;
$customer = $result->customer;
```

--------------------------------

### GET /api/v2/gifts

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Lists all gifts.

```APIDOC
## GET /api/v2/gifts

### Description
Lists all gifts.

### Method
GET

### Endpoint
/api/v2/gifts

```

--------------------------------

### TelemetryAdapter::onRequestStart

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/telemetry.md

Called once before the retry loop of an SDK API call. Receives start metadata and a mutable reference to request headers so the adapter can inject W3C trace context for propagation. Returns an opaque handle passed to onRequestEnd.

```APIDOC
## [POST] /telemetry/onRequestStart

### Description
Called once before the retry loop of an SDK API call. Receives start metadata and a mutable reference to request headers so the adapter can inject W3C trace context for propagation. Returns an opaque handle passed to onRequestEnd.

### Method
POST

### Endpoint
/telemetry/onRequestStart

### Parameters
#### Request Body
- **context** (RequestTelemetryContext) - Required - Start metadata including span name, resource, operation, HTTP method, URL, server address, Chargebee site, API version, SDK name/version, and start attributes.
- **requestHeaders** (array) - Required - Mutable reference to request headers. Inject W3C `traceparent`/`tracestate` here for propagation.

### Request Example
{
  "context": {
    "spanName": "chargebee.subscription.create",
    "resource": "subscription",
    "operation": "create",
    "httpMethod": "POST",
    "httpUrl": "https://{site}.chargebee.com/api/v2/subscriptions",
    "serverAddress": "{site}.chargebee.com",
    "chargebeeSite": "{site}",
    "chargebeeApiVersion": "v2",
    "sdkName": "chargebee-php",
    "sdkVersion": "2.0.0",
    "startAttributes": {
      "url.full": "https://{site}.chargebee.com/api/v2/subscriptions",
      "http.request.method": "POST",
      "server.address": "{site}.chargebee.com",
      "chargebee.site": "{site}",
      "chargebee.api_version": "v2",
      "chargebee.resource": "subscription",
      "chargebee.operation": "create",
      "chargebee.sdk.name": "chargebee-php",
      "chargebee.sdk.version": "2.0.0"
    }
  },
  "requestHeaders": {
    "traceparent": "00-...",
    "tracestate": "..."
  }
}

### Response
#### Success Response (200)
- **handle** (mixed) - Opaque handle to be passed to onRequestEnd. May be null.

#### Response Example
{
  "handle": "opaque-handle-value"
}
```

--------------------------------

### GET /api/v2/subscriptions

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/subscription.md

Lists all subscriptions.

```APIDOC
## GET /api/v2/subscriptions

### Description
Lists all subscriptions.

### Method
GET

### Endpoint
/api/v2/subscriptions

### Parameters
#### Query Parameters
- **params** (array) - Optional - Operation parameters; exhaustive shapes are documented in the interface @param doc-blocks.

#### Headers
- **headers** (array) - Optional - Extra request headers.

### Request Example
```json
{
  "params": {},
  "headers": {}
}
```

### Response
#### Success Response (200)
- **ListSubscriptionResponse** (object) - Typed response extending `ResponseBase`.

#### Response Example
```json
{
  "subscriptions": []
}
```
```

--------------------------------

### GET /api/v2/vaulted_payment_methods/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Retrieves a vaulted payment method by ID.

```APIDOC
## GET /api/v2/vaulted_payment_methods/{id}

### Description
Retrieves a vaulted payment method by ID.

### Method
GET

### Endpoint
/api/v2/vaulted_payment_methods/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The vaulted payment method ID.

### Response
#### Success Response (200)
Returns the vaulted payment method details.

#### Response Example
{
  "id": "pm_123",
  "type": "card"
}
```

--------------------------------

### Create a plan and copy from another site

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/plan.md

Shows how to create a monthly plan with the Chargebee PHP SDK and then copy a plan from another site. The create call returns a plan object whose status can be checked; the copy call uses from_site and id_at_from_site parameters.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(["site" => "acme", "apiKey" => "test_..."]);

// create a monthly plan
$result = $chargebee->plan()->create([
    "id" => "basic",
    "name" => "Basic",
    "price" => 1000,
    "period" => 1,
    "period_unit" => "month",
    "charge_model" => "full_charge",
]);
$plan = $result->plan;
echo $plan->status; // Chargebee\Resources\Plan\Enums\Status (active | archived | deleted)

// copy a plan from another site
$chargebee->plan()->copy(["from_site" => "legacy-site", "id_at_from_site" => "basic"]);
```

--------------------------------

### GET /api/v2/currencies/list

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Lists all currencies.

```APIDOC
## GET /api/v2/currencies/list

### Description
Lists all currencies.

### Method
GET

### Endpoint
/api/v2/currencies/list

```

--------------------------------

### GET /api/v2/virtual_bank_accounts/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Retrieves a virtual bank account by ID.

```APIDOC
## GET /api/v2/virtual_bank_accounts/{id}

### Description
Retrieves a virtual bank account by ID.

### Method
GET

### Endpoint
/api/v2/virtual_bank_accounts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The virtual bank account ID.

### Response
#### Success Response (200)
Returns the virtual bank account details.

#### Response Example
{
  "id": "vba_123",
  "status": "active"
}
```

--------------------------------

### Method Binding in ChargebeeClient (Before vs Now)

Source: https://github.com/chargebee/chargebee-php/wiki/Migration-guide-for-v4

Demonstrates how to perform operations using the new client instance instead of static class methods.

```php
use ChargeBee\ChargeBee\Environment;
use ChargeBee\ChargeBee\Models\Customer;
Environment::configure("{site}", "{site_api_key}");
$result = Customer::retrieve("{customer-id}");
```

```php
use Chargebee\ChargebeeClient;
$chargebee = new ChargebeeClient([
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$response = $chargebee->customer()->retrieve("{customer-id}");
```

--------------------------------

### GET /api/v2/alerts

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Lists all alerts.

```APIDOC
## GET /api/v2/alerts

### Description
Lists all alerts.

### Method
GET

### Endpoint
/api/v2/alerts

```

--------------------------------

### GET /api/v2/addresses

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Retrieves an address.

```APIDOC
## GET /api/v2/addresses

### Description
Retrieves an address.

### Method
GET

### Endpoint
/api/v2/addresses

```

--------------------------------

### Chargebee\Environment::__construct

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/environment.md

Creates an Environment instance with the given site name and API key. The API key is used for Basic authentication.

```APIDOC
## `Chargebee\Environment::__construct`

### Description
Creates a new Environment instance holding connection and behavior state for a Chargebee site.

### Method
Constructor

### Signature
```php
public function __construct(string $site, string $apiKey)
```

### Parameters
- **$site** (string) - Required - Chargebee site name
- **$apiKey** (string) - Required - API key (sent as Basic auth)

### Return Value
No return value (constructor).
```

--------------------------------

### all

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/plan.md

Lists all plans with optional filters and pagination. Returns a ListPlanResponse containing an array of plans and a next_offset for pagination.

```APIDOC
## GET /api/v2/plans

### Description
Retrieves a list of plans based on filters and pagination parameters.

### Method
GET

### Endpoint
/api/v2/plans

### Parameters
#### Query Parameters
- **id** (string) - Optional - Filter by plan ID.
- **name** (string) - Optional - Filter by plan name.
- **price** (integer) - Optional - Filter by price.
- **period** (integer) - Optional - Filter by billing period.
- **status** (string) - Optional - Filter by status (e.g., 'active', 'archived').
- **charge_model** (string) - Optional - Filter by charge model.
- **limit** (integer) - Optional - Maximum number of records to return.
- **offset** (string) - Optional - Pagination offset.
- **include_deleted** (boolean) - Optional - Include deleted plans.
- **sort_by** (string) - Optional - Sort field and direction.

### Request Example
(No request body)

### Response
#### Success Response (200)
- **list** (array<Plan>) - List of plans.
- **next_offset** (string) - Pagination token for next page.

#### Response Example
{
  "list": [
    {
      "id": "basic",
      "name": "Basic",
      "price": 1000,
      "period": 1,
      "period_unit": "month",
      "status": "active"
    }
  ],
  "next_offset": "eyJvZmZzZXQiOjEwfQ=="
}
```

--------------------------------

### GET /api/v2/omnichannel_one_time_orders/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Retrieves a specific omnichannel one-time order by its ID.

```APIDOC
## GET /api/v2/omnichannel_one_time_orders/{id}

### Description
Retrieves a specific omnichannel one-time order by its ID.

### Method
GET

### Endpoint
/api/v2/omnichannel_one_time_orders/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the omnichannel one-time order.

### Request Example
{}

### Response
#### Success Response (200)
- No response fields documented.

#### Response Example
{}
```

--------------------------------

### Constructor with default HTTP client

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/chargebee-client.md

Creates a ChargebeeClient instance with required options 'site' and 'apiKey'. Throws an exception if options are invalid or missing required keys.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient([
    "site" => "acme",
    "apiKey" => "test_8Z2mFeJY5dL85a5hlyk2U4XY1VKKhZ4Kt",
]);
```

--------------------------------

### GET /api/v2/customers

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/customer.md

Lists all customers.

```APIDOC
## GET /api/v2/customers

### Description
Lists all customers.

### Method
GET

### Endpoint
/api/v2/customers

### Parameters
#### Query Parameters
- **params** (array) - Optional - List filters and pagination.
- **headers** (array) - Optional - Additional headers.

### Request Example
```json
{
  "params": {},
  "headers": {}
}
```

### Response
#### Success Response (200)
- **ListCustomerResponse** - A list of customers.

#### Response Example
```json
{
  "list": []
}
```
```

--------------------------------

### Configuration::all

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Retrieves all configurations.

```APIDOC
## GET /api/v2/configurations

### Description
Retrieves all configurations.

### Method
GET

### Endpoint
/api/v2/configurations

```

--------------------------------

### GET /api/v2/omnichannel_subscription_items/{id}/scheduled_changes

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists scheduled changes for a specific omnichannel subscription item.

```APIDOC
## GET /api/v2/omnichannel_subscription_items/{id}/scheduled_changes

### Description
Lists scheduled changes for a specific omnichannel subscription item.

### Method
GET

### Endpoint
/api/v2/omnichannel_subscription_items/{id}/scheduled_changes

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the omnichannel subscription item.

### Request Example
{}

### Response
#### Success Response (200)
- No response fields documented.

#### Response Example
{}
```

--------------------------------

### Plan::create

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Creates a new plan.

```APIDOC
## POST /api/v2/plans

### Description
Creates a new plan.

### Method
POST

### Endpoint
/api/v2/plans

### Request Body
- **plan** (object) - Required - The plan details.

### Response
#### Success Response (200)
- **plan** (object) - The created plan.

#### Response Example
{
  "plan": {}
}
```

--------------------------------

### GET /api/v2/hosted_pages

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Lists all hosted pages.

```APIDOC
## GET /api/v2/hosted_pages

### Description
Lists all hosted pages.

### Method
GET

### Endpoint
/api/v2/hosted_pages

```

--------------------------------

### GET /api/v2/grant_blocks

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Lists grant blocks.

```APIDOC
## GET /api/v2/grant_blocks

### Description
Lists grant blocks.

### Method
GET

### Endpoint
/api/v2/grant_blocks

```

--------------------------------

### GET /api/v2/alerts/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Retrieves an alert.

```APIDOC
## GET /api/v2/alerts/{id}

### Description
Retrieves an alert.

### Method
GET

### Endpoint
/api/v2/alerts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the alert.

```

--------------------------------

### Create, convert, and download a quote

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/quote.md

Shows the full workflow: create a quote for a new subscription, convert it to a subscription, and download the PDF. The PDF download returns a Download resource with a 'download' -> 'url' field.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(["site" => "acme", "apiKey" => "test_..."]);

// create a quote for a new subscription for an existing customer
$result = $chargebee->quote()->createSubForCustomerQuote("cust_123", [
    "plan_id" => "basic",
    "coupon" => "OFFER10",
]);
$quote = $result->quote;

// convert the quote to a subscription
$converted = $chargebee->quote()->convert($quote->id);
echo $converted->subscription->id;

// download the quote PDF (returns a Download resource with "download" -> "url")
$pdf = $chargebee->quote()->pdf($quote->id);
```

--------------------------------

### Plan::all

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints-two.md

Lists all plans.

```APIDOC
## GET /api/v2/plans

### Description
Lists all plans.

### Method
GET

### Endpoint
/api/v2/plans

### Response
#### Success Response (200)
- **plans** (array) - List of plans.

#### Response Example
{
  "plans": []
}
```

--------------------------------

### GET /api/v2/addons/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Retrieves an addon.

```APIDOC
## GET /api/v2/addons/{id}

### Description
Retrieves an addon.

### Method
GET

### Endpoint
/api/v2/addons/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The identifier of the addon.

```

--------------------------------

### PsrClientAdapter create() method

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/http-client.md

Returns the wrapped PSR-18 client.

```php
public function create(): ClientInterface
```

--------------------------------

### GET /api/v2/gifts/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Retrieves a gift by ID.

```APIDOC
## GET /api/v2/gifts/{id}

### Description
Retrieves a gift by ID.

### Method
GET

### Endpoint
/api/v2/gifts/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the gift to retrieve.

```

--------------------------------

### Initiate a customers export

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/export.md

Creates a Chargebee client and kicks off a customers export. The response includes the export object with id, operation_type, status, mime_type, and download model.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(["site" => "acme", "apiKey" => "test_..."]);

// kick off an export
$result = $chargebee->export()->customers([
    "report_by" => "chargebee",
    "download" => ["type" => "meta", "mime_type" => "application/zip"],
]);
$export = $result->export;
echo $export->id;              // "export_123"
echo $export->operation_type;  // "customers"
echo $export->status;          // "in_progress" | "completed" | ...
echo $export->mime_type;
echo $export->download;        // Download model with ->url once ready
```

--------------------------------

### GET /api/v2/subscriptions/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/subscription.md

Retrieves a subscription by ID.

```APIDOC
## GET /api/v2/subscriptions/{id}

### Description
Retrieves a subscription by ID.

### Method
GET

### Endpoint
/api/v2/subscriptions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The subscription ID.

#### Headers
- **headers** (array) - Optional - Extra request headers.

### Request Example
```json
{
  "id": "subscription_id",
  "headers": {}
}
```

### Response
#### Success Response (200)
- **RetrieveSubscriptionResponse** (object) - Typed response extending `ResponseBase`.

#### Response Example
```json
{
  "subscription": {}
}
```
```

--------------------------------

### GET /api/v2/currencies/{id}

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/endpoints.md

Retrieves a currency by ID.

```APIDOC
## GET /api/v2/currencies/{id}

### Description
Retrieves a currency by ID.

### Method
GET

### Endpoint
/api/v2/currencies/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The currency ID.

```

--------------------------------

### create

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/plan.md

Creates a new plan. Requires parameters such as id, name, price, period, and period_unit. Returns a CreatePlanResponse containing the created plan.

```APIDOC
## POST /api/v2/plans

### Description
Creates a new plan with the provided parameters.

### Method
POST

### Endpoint
/api/v2/plans

### Parameters
#### Request Body
- **id** (string) - Required - Unique identifier for the plan.
- **name** (string) - Required - Display name of the plan.
- **invoice_name** (string) - Optional - Name to show on invoices.
- **description** (string) - Optional - Description of the plan.
- **price** (integer) - Required - Price in the smallest currency unit (e.g., cents).
- **currency_code** (string) - Optional - ISO 4217 currency code.
- **period** (integer) - Required - Billing period length.
- **period_unit** (string) - Required - Unit of the billing period (e.g., 'month', 'year').
- **trial_period** (integer) - Optional - Trial period length.
- **trial_period_unit** (string) - Optional - Unit of the trial period.
- **trial_end_action** (string) - Optional - Action after trial ends.
- **billing_cycles** (integer) - Optional - Number of billing cycles.
- **charge_model** (string) - Optional - 'full_charge' or 'prorate'.
- **auto_collection** (boolean) - Optional - Whether auto-collection is enabled.
- **taxable** (boolean) - Optional - Whether the plan is taxable.
- **tax_profile_id** (string) - Optional - Tax profile identifier.
- **redirect_url** (string) - Optional - Redirect URL after checkout.
- **enabled_in_hosted_pages** (boolean) - Optional - Enable in hosted pages.
- **enabled_in_portal** (boolean) - Optional - Enable in customer portal.
- **applicable_addons** (array) - Optional - List of applicable addons, each with 'id' and 'type' (e.g., 'mandatory').
- **event_based_addons** (array) - Optional - Event-based addons.
- **attached_addons** (array) - Optional - Attached addons.
- **tax_handling** (string) - Optional - Tax handling method.
- **product_id** (string) - Optional - Associated product ID.
- **meta_data** (object) - Optional - Additional metadata.
- **pricing_model** (string) - Optional - Pricing model type.
- **tiers** (array) - Optional - Tiered pricing, each with 'starting_unit', 'ending_unit', 'price', and optional '*_in_decimal' variants.

### Request Example
{
  "id": "basic",
  "name": "Basic",
  "price": 1000,
  "period": 1,
  "period_unit": "month",
  "charge_model": "full_charge"
}

### Response
#### Success Response (200)
- **plan** (Plan) - The created plan object.

#### Response Example
{
  "plan": {
    "id": "basic",
    "name": "Basic",
    "price": 1000,
    "period": 1,
    "period_unit": "month",
    "status": "active"
  }
}
```

--------------------------------

### GET /api/v2/transactions

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/transaction.md

Lists all transactions with optional filters.

```APIDOC
## GET /api/v2/transactions

### Description
Lists all transactions with optional filters.

### Method
GET

### Endpoint
/api/v2/transactions

### Parameters
#### Query Parameters
- **params** (array) - Optional - Filter parameters for listing transactions.

### Response
#### Success Response (200)
- **list** (array) - List of transactions.

#### Response Example
{
  "list": []
}
```

--------------------------------

### Create, refund, and list credit notes

Source: https://github.com/chargebee/chargebee-php/blob/master/_autodocs/api-reference/credit-note.md

Shows how to create an ad-hoc credit note, refund it to the customer's card, and list a customer's credit notes using the Chargebee PHP client. Requires a ChargebeeClient instance with site and API key.

```php
use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(["site" => "acme", "apiKey" => "test_..."]);

// create an ad-hoc credit note
$result = $chargebee->creditNote()->create([
    "customer_id" => "cust_123",
    "total" => 2500,
    "type" => "adjustment",
    "reason_code" => "product_issue",
]);
$cn = $result->credit_note;

// refund it to the customer's card
$chargebee->creditNote()->refund($cn->id, [
    "refund" => ["amount" => 2500, "type" => "card"],
]);

// list a customer's credit notes
$page = $chargebee->creditNote()->creditNotesForCustomer("cust_123", ["limit" => 10]);
foreach ($page->list as $entry) {
    echo $entry->credit_note->total, " ", $entry->credit_note->status;
}
```
Tokens:
Raw