reference.md

# Reference
## accounts
<details><summary><code>client.accounts.listAccountMembers() -> ListAccountMembersResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().listAccountMembers(
    ListAccountMembersRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search filter
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.getAccountMember(accountMemberId) -> GetAccountMemberResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().getAccountMember("account_member_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**accountMemberId:** `String` — account_member_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.listApiKeys() -> ListApiKeysResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().listApiKeys(
    ListApiKeysRequest
        .builder()
        .requireEnvironment(true)
        .environmentId("environment_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**environmentId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**requireEnvironment:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.createApiKey(request) -> CreateApiKeyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().createApiKey(
    CreateApiKeyRequestBody
        .builder()
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**description:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**environmentId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**readonly:** `Optional<Boolean>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.getApiKey(apiKeyId) -> GetApiKeyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().getApiKey("api_key_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**apiKeyId:** `String` — api_key_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.updateApiKey(apiKeyId, request) -> UpdateApiKeyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().updateApiKey(
    "api_key_id",
    UpdateApiKeyRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**apiKeyId:** `String` — api_key_id
    
</dd>
</dl>

<dl>
<dd>

**description:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.deleteApiKey(apiKeyId) -> DeleteApiKeyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().deleteApiKey("api_key_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**apiKeyId:** `String` — api_key_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.countApiKeys() -> CountApiKeysResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().countApiKeys(
    CountApiKeysRequest
        .builder()
        .requireEnvironment(true)
        .environmentId("environment_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**environmentId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**requireEnvironment:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.listAuditLogs() -> ListAuditLogsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().listAuditLogs(
    ListAuditLogsRequest
        .builder()
        .actorType(ActorType.API_KEY)
        .endTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .environmentId("environment_id")
        .q("q")
        .startTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**actorType:** `Optional<ActorType>` 
    
</dd>
</dl>

<dl>
<dd>

**endTime:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**environmentId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.getAuditLog(auditLogId) -> GetAuditLogResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().getAuditLog("audit_log_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**auditLogId:** `String` — audit_log_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.countAuditLogs() -> CountAuditLogsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().countAuditLogs(
    CountAuditLogsRequest
        .builder()
        .actorType(ActorType.API_KEY)
        .endTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .environmentId("environment_id")
        .q("q")
        .startTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**actorType:** `Optional<ActorType>` 
    
</dd>
</dl>

<dl>
<dd>

**endTime:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**environmentId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.listEnvironments() -> ListEnvironmentsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().listEnvironments(
    ListEnvironmentsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.createEnvironment(request) -> CreateEnvironmentResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().createEnvironment(
    CreateEnvironmentRequestBody
        .builder()
        .environmentType(EnvironmentType.DEVELOPMENT)
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**environmentType:** `EnvironmentType` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.getEnvironment(environmentId) -> GetEnvironmentResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().getEnvironment("environment_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**environmentId:** `String` — environment_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.updateEnvironment(environmentId, request) -> UpdateEnvironmentResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().updateEnvironment(
    "environment_id",
    UpdateEnvironmentRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**environmentId:** `String` — environment_id
    
</dd>
</dl>

<dl>
<dd>

**environmentType:** `Optional<EnvironmentType>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.deleteEnvironment(environmentId) -> DeleteEnvironmentResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().deleteEnvironment("environment_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**environmentId:** `String` — environment_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.quickstart() -> QuickstartResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().quickstart();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.accounts.getWhoAmI() -> GetWhoAmIResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accounts().getWhoAmI();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## billing
<details><summary><code>client.billing.listCoupons() -> ListCouponsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().listCoupons(
    ListCouponsRequest
        .builder()
        .isActive(true)
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**isActive:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.upsertBillingCoupon(request) -> UpsertBillingCouponResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().upsertBillingCoupon(
    CreateCouponRequestBody
        .builder()
        .amountOff(1000000L)
        .duration("duration")
        .durationInMonths(1000000L)
        .externalId("external_id")
        .maxRedemptions(1000000L)
        .name("name")
        .percentOff(1.1)
        .timesRedeemed(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**amountOff:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**duration:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**durationInMonths:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**externalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**maxRedemptions:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**percentOff:** `Double` 
    
</dd>
</dl>

<dl>
<dd>

**timesRedeemed:** `Long` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.upsertBillingCustomer(request) -> UpsertBillingCustomerResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().upsertBillingCustomer(
    CreateBillingCustomerRequestBody
        .builder()
        .email("email")
        .externalId("external_id")
        .name("name")
        .meta(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**defaultPaymentMethodId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**email:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**externalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**meta:** `Map<String, String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.listCustomersWithSubscriptions() -> ListCustomersWithSubscriptionsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().listCustomersWithSubscriptions(
    ListCustomersWithSubscriptionsRequest
        .builder()
        .companyIds(
            Arrays.asList("company_ids")
        )
        .name("name")
        .providerType(BillingProviderType.ORB)
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.countCustomers() -> CountCustomersResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().countCustomers(
    CountCustomersRequest
        .builder()
        .companyIds(
            Arrays.asList("company_ids")
        )
        .name("name")
        .providerType(BillingProviderType.ORB)
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.listInvoices() -> ListInvoicesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().listInvoices(
    ListInvoicesRequest
        .builder()
        .customerExternalId("customer_external_id")
        .subscriptionExternalId("subscription_external_id")
        .companyId("company_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**customerExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**subscriptionExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.upsertInvoice(request) -> UpsertInvoiceResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().upsertInvoice(
    CreateInvoiceRequestBody
        .builder()
        .amountDue(1000000L)
        .amountPaid(1000000L)
        .amountRemaining(1000000L)
        .collectionMethod("collection_method")
        .currency("currency")
        .customerExternalId("customer_external_id")
        .subtotal(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**amountDue:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**amountPaid:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**amountRemaining:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**collectionMethod:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**customerExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**dueDate:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**externalId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**paymentMethodExternalId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<InvoiceStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**subscriptionExternalId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**subtotal:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**url:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.listMeters() -> ListMetersResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().listMeters(
    ListMetersRequest
        .builder()
        .displayName("display_name")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**displayName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.upsertBillingMeter(request) -> UpsertBillingMeterResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().upsertBillingMeter(
    CreateMeterRequestBody
        .builder()
        .displayName("display_name")
        .eventName("event_name")
        .eventPayloadKey("event_payload_key")
        .externalId("external_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**displayName:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**eventName:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**eventPayloadKey:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**externalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.listPaymentMethods() -> ListPaymentMethodsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().listPaymentMethods(
    ListPaymentMethodsRequest
        .builder()
        .customerExternalId("customer_external_id")
        .companyId("company_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**customerExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.upsertPaymentMethod(request) -> UpsertPaymentMethodResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().upsertPaymentMethod(
    CreatePaymentMethodRequestBody
        .builder()
        .customerExternalId("customer_external_id")
        .externalId("external_id")
        .paymentMethodType("payment_method_type")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**accountLast4:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**accountName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**bankName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**billingEmail:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**billingName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**cardBrand:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**cardExpMonth:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**cardExpYear:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**cardLast4:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**customerExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**externalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**paymentMethodType:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.deletePaymentMethodByExternalId(billingId) -> DeletePaymentMethodByExternalIdResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().deletePaymentMethodByExternalId("billing_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingId:** `String` — billing_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.listBillingPrices() -> ListBillingPricesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().listBillingPrices(
    ListBillingPricesRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .productIds(
            Arrays.asList("product_ids")
        )
        .currency("currency")
        .forInitialPlan(true)
        .forTrialExpiryPlan(true)
        .interval("interval")
        .isActive(true)
        .price(1000000L)
        .productId("product_id")
        .providerType(BillingProviderType.ORB)
        .q("q")
        .tiersMode(BillingTiersMode.GRADUATED)
        .usageType(BillingPriceUsageType.LICENSED)
        .withMeter(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**currency:** `Optional<String>` — Filter for prices in a specific currency (e.g. usd, eur)
    
</dd>
</dl>

<dl>
<dd>

**forInitialPlan:** `Optional<Boolean>` — Filter for prices valid for initial plans (free prices only)
    
</dd>
</dl>

<dl>
<dd>

**forTrialExpiryPlan:** `Optional<Boolean>` — Filter for prices valid for trial expiry plans (free prices only)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**interval:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**isActive:** `Optional<Boolean>` — Filter for active prices on active products (defaults to true if not specified)
    
</dd>
</dl>

<dl>
<dd>

**price:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**productId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**productIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**tiersMode:** `Optional<BillingTiersMode>` 
    
</dd>
</dl>

<dl>
<dd>

**usageType:** `Optional<BillingPriceUsageType>` 
    
</dd>
</dl>

<dl>
<dd>

**withMeter:** `Optional<Boolean>` — Filter for prices with a meter
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.upsertBillingPrice(request) -> UpsertBillingPriceResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().upsertBillingPrice(
    CreateBillingPriceRequestBody
        .builder()
        .billingScheme(BillingPriceScheme.PER_UNIT)
        .currency("currency")
        .externalAccountId("external_account_id")
        .interval("interval")
        .isActive(true)
        .price(1000000L)
        .priceExternalId("price_external_id")
        .productExternalId("product_external_id")
        .usageType(BillingPriceUsageType.LICENSED)
        .priceTiers(
            Arrays.asList(
                CreateBillingPriceTierRequestBody
                    .builder()
                    .priceExternalId("price_external_id")
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingScheme:** `BillingPriceScheme` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**externalAccountId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**interval:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**intervalCount:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**isActive:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**meterId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**nickname:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**packageSize:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**price:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**priceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**priceExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**priceTiers:** `List<CreateBillingPriceTierRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**productExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>

<dl>
<dd>

**tiersMode:** `Optional<BillingTiersMode>` 
    
</dd>
</dl>

<dl>
<dd>

**usageType:** `BillingPriceUsageType` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.deleteBillingProduct(billingId) -> DeleteBillingProductResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().deleteBillingProduct("billing_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingId:** `String` — billing_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.listBillingProductPrices() -> ListBillingProductPricesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().listBillingProductPrices(
    ListBillingProductPricesRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .productIds(
            Arrays.asList("product_ids")
        )
        .currency("currency")
        .forInitialPlan(true)
        .forTrialExpiryPlan(true)
        .interval("interval")
        .isActive(true)
        .price(1000000L)
        .productId("product_id")
        .providerType(BillingProviderType.ORB)
        .q("q")
        .tiersMode(BillingTiersMode.GRADUATED)
        .usageType(BillingPriceUsageType.LICENSED)
        .withMeter(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**currency:** `Optional<String>` — Filter for prices in a specific currency (e.g. usd, eur)
    
</dd>
</dl>

<dl>
<dd>

**forInitialPlan:** `Optional<Boolean>` — Filter for prices valid for initial plans (free prices only)
    
</dd>
</dl>

<dl>
<dd>

**forTrialExpiryPlan:** `Optional<Boolean>` — Filter for prices valid for trial expiry plans (free prices only)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**interval:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**isActive:** `Optional<Boolean>` — Filter for active prices on active products (defaults to true if not specified)
    
</dd>
</dl>

<dl>
<dd>

**price:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**productId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**productIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**tiersMode:** `Optional<BillingTiersMode>` 
    
</dd>
</dl>

<dl>
<dd>

**usageType:** `Optional<BillingPriceUsageType>` 
    
</dd>
</dl>

<dl>
<dd>

**withMeter:** `Optional<Boolean>` — Filter for prices with a meter
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.deleteProductPrice(billingId) -> DeleteProductPriceResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().deleteProductPrice("billing_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingId:** `String` — billing_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.upsertBillingProduct(request) -> UpsertBillingProductResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().upsertBillingProduct(
    CreateBillingProductRequestBody
        .builder()
        .externalId("external_id")
        .price(1.1)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**externalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**isActive:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**price:** `Double` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.listBillingProducts() -> ListBillingProductsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().listBillingProducts(
    ListBillingProductsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .isActive(true)
        .name("name")
        .priceUsageType(BillingPriceUsageType.LICENSED)
        .providerType(BillingProviderType.ORB)
        .q("q")
        .recurringChargesOnly(true)
        .withOneTimeCharges(true)
        .withPricesOnly(true)
        .withZeroPrice(true)
        .withoutLinkedToPlan(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**isActive:** `Optional<Boolean>` — Filter products that are active. Defaults to true if not specified
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**priceUsageType:** `Optional<BillingPriceUsageType>` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**recurringChargesOnly:** `Optional<Boolean>` — Filter to products that have at least one recurring price
    
</dd>
</dl>

<dl>
<dd>

**withOneTimeCharges:** `Optional<Boolean>` — Filter products that are one time charges
    
</dd>
</dl>

<dl>
<dd>

**withPricesOnly:** `Optional<Boolean>` — Filter products that have prices
    
</dd>
</dl>

<dl>
<dd>

**withZeroPrice:** `Optional<Boolean>` — Filter products that have zero price for free subscription type
    
</dd>
</dl>

<dl>
<dd>

**withoutLinkedToPlan:** `Optional<Boolean>` — Filter products that are not linked to any plan
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.countBillingProducts() -> CountBillingProductsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().countBillingProducts(
    CountBillingProductsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .isActive(true)
        .name("name")
        .priceUsageType(BillingPriceUsageType.LICENSED)
        .providerType(BillingProviderType.ORB)
        .q("q")
        .recurringChargesOnly(true)
        .withOneTimeCharges(true)
        .withPricesOnly(true)
        .withZeroPrice(true)
        .withoutLinkedToPlan(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**isActive:** `Optional<Boolean>` — Filter products that are active. Defaults to true if not specified
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**priceUsageType:** `Optional<BillingPriceUsageType>` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**recurringChargesOnly:** `Optional<Boolean>` — Filter to products that have at least one recurring price
    
</dd>
</dl>

<dl>
<dd>

**withOneTimeCharges:** `Optional<Boolean>` — Filter products that are one time charges
    
</dd>
</dl>

<dl>
<dd>

**withPricesOnly:** `Optional<Boolean>` — Filter products that have prices
    
</dd>
</dl>

<dl>
<dd>

**withZeroPrice:** `Optional<Boolean>` — Filter products that have zero price for free subscription type
    
</dd>
</dl>

<dl>
<dd>

**withoutLinkedToPlan:** `Optional<Boolean>` — Filter products that are not linked to any plan
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.billing.upsertBillingSubscription(request) -> UpsertBillingSubscriptionResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.billing().upsertBillingSubscription(
    CreateBillingSubscriptionRequestBody
        .builder()
        .cancelAtPeriodEnd(true)
        .currency("currency")
        .customerExternalId("customer_external_id")
        .expiredAt(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .subscriptionExternalId("subscription_external_id")
        .totalPrice(1000000L)
        .discounts(
            Arrays.asList(
                BillingSubscriptionDiscount
                    .builder()
                    .couponExternalId("coupon_external_id")
                    .externalId("external_id")
                    .isActive(true)
                    .startedAt(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
                    .build()
            )
        )
        .productExternalIds(
            Arrays.asList(
                BillingProductPricing
                    .builder()
                    .currency("currency")
                    .interval("interval")
                    .price(1000000L)
                    .priceExternalId("price_external_id")
                    .productExternalId("product_external_id")
                    .quantity(1000000L)
                    .usageType(BillingPriceUsageType.LICENSED)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**applicationId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**cancelAt:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**cancelAtPeriodEnd:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**customerExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**defaultPaymentMethodExternalId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**defaultPaymentMethodId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**discounts:** `List<BillingSubscriptionDiscount>` 
    
</dd>
</dl>

<dl>
<dd>

**expiredAt:** `OffsetDateTime` 
    
</dd>
</dl>

<dl>
<dd>

**interval:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `Optional<Map<String, Object>>` 
    
</dd>
</dl>

<dl>
<dd>

**periodEnd:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**periodStart:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**productExternalIds:** `List<BillingProductPricing>` 
    
</dd>
</dl>

<dl>
<dd>

**providerType:** `Optional<BillingProviderType>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**subscriptionExternalId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**totalPrice:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**trialEnd:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**trialEndSetting:** `Optional<BillingSubscriptionTrialEndSetting>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## credits
<details><summary><code>client.credits.listBillingCredits() -> ListBillingCreditsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().listBillingCredits(
    ListBillingCreditsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .name("name")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.createBillingCredit(request) -> CreateBillingCreditResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().createBillingCredit(
    CreateBillingCreditRequestBody
        .builder()
        .currency("currency")
        .description("description")
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**burnStrategy:** `Optional<BillingCreditBurnStrategy>` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**currencyPrices:** `Optional<List<CreditCurrencyPriceRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**defaultExpiryUnit:** `Optional<BillingCreditExpiryUnit>` 
    
</dd>
</dl>

<dl>
<dd>

**defaultExpiryUnitCount:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**defaultRolloverPolicy:** `Optional<BillingCreditRolloverPolicy>` 
    
</dd>
</dl>

<dl>
<dd>

**description:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**icon:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**perUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**perUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**pluralName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**singularName:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.getSingleBillingCredit(creditId) -> GetSingleBillingCreditResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().getSingleBillingCredit("credit_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditId:** `String` — credit_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.updateBillingCredit(creditId, request) -> UpdateBillingCreditResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().updateBillingCredit(
    "credit_id",
    UpdateBillingCreditRequestBody
        .builder()
        .description("description")
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditId:** `String` — credit_id
    
</dd>
</dl>

<dl>
<dd>

**burnStrategy:** `Optional<BillingCreditBurnStrategy>` 
    
</dd>
</dl>

<dl>
<dd>

**currencyPrices:** `Optional<List<CreditCurrencyPriceRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**defaultExpiryUnit:** `Optional<BillingCreditExpiryUnit>` 
    
</dd>
</dl>

<dl>
<dd>

**defaultExpiryUnitCount:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**defaultRolloverPolicy:** `Optional<BillingCreditRolloverPolicy>` 
    
</dd>
</dl>

<dl>
<dd>

**description:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**icon:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**perUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**perUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**pluralName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**singularName:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.softDeleteBillingCredit(creditId) -> SoftDeleteBillingCreditResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().softDeleteBillingCredit("credit_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditId:** `String` — credit_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.listCompanyCreditBalances() -> ListCompanyCreditBalancesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().listCompanyCreditBalances(
    ListCompanyCreditBalancesRequest
        .builder()
        .companyId("company_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.listCreditBundles() -> ListCreditBundlesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().listCreditBundles(
    ListCreditBundlesRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .creditId("credit_id")
        .status(BillingCreditBundleStatus.ACTIVE)
        .bundleType("fixed")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**creditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<BillingCreditBundleStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**bundleType:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.createCreditBundle(request) -> CreateCreditBundleResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().createCreditBundle(
    CreateCreditBundleRequestBody
        .builder()
        .bundleName("bundle_name")
        .creditId("credit_id")
        .currency("currency")
        .pricePerUnit(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**bundleName:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**bundleType:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**creditId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**currencyPrices:** `Optional<List<CreditBundleCurrencyPriceRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryType:** `Optional<BillingCreditExpiryType>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryUnit:** `Optional<BillingCreditExpiryUnit>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryUnitCount:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**pricePerUnit:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**pricePerUnitDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**quantity:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<BillingCreditBundleStatus>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.getCreditBundle(bundleId) -> GetCreditBundleResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().getCreditBundle("bundle_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**bundleId:** `String` — bundle_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.updateCreditBundleDetails(bundleId, request) -> UpdateCreditBundleDetailsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().updateCreditBundleDetails(
    "bundle_id",
    UpdateCreditBundleDetailsRequestBody
        .builder()
        .bundleName("bundle_name")
        .pricePerUnit(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**bundleId:** `String` — bundle_id
    
</dd>
</dl>

<dl>
<dd>

**bundleName:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**currencyPrices:** `Optional<List<CreditBundleCurrencyPriceRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryType:** `Optional<BillingCreditExpiryType>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryUnit:** `Optional<BillingCreditExpiryUnit>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryUnitCount:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**pricePerUnit:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**pricePerUnitDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**quantity:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<BillingCreditBundleStatus>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.deleteCreditBundle(bundleId) -> DeleteCreditBundleResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().deleteCreditBundle("bundle_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**bundleId:** `String` — bundle_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.countCreditBundles() -> CountCreditBundlesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().countCreditBundles(
    CountCreditBundlesRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .creditId("credit_id")
        .status(BillingCreditBundleStatus.ACTIVE)
        .bundleType("fixed")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**creditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<BillingCreditBundleStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**bundleType:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.countBillingCredits() -> CountBillingCreditsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().countBillingCredits(
    CountBillingCreditsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .name("name")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.zeroOutGrant(grantId, request) -> ZeroOutGrantResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().zeroOutGrant(
    "grant_id",
    ZeroOutGrantRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**grantId:** `String` — grant_id
    
</dd>
</dl>

<dl>
<dd>

**reason:** `Optional<BillingCreditGrantZeroedOutReason>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.grantBillingCreditsToCompany(request) -> GrantBillingCreditsToCompanyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().grantBillingCreditsToCompany(
    CreateCompanyCreditGrant
        .builder()
        .companyId("company_id")
        .creditId("credit_id")
        .quantity(1000000L)
        .reason(BillingCreditGrantReason.ADJUSTMENT)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingPeriodsCount:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**creditId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**expiresAt:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryType:** `Optional<BillingCreditExpiryType>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryUnit:** `Optional<BillingCreditExpiryUnit>` 
    
</dd>
</dl>

<dl>
<dd>

**expiryUnitCount:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**quantity:** `Long` 
    
</dd>
</dl>

<dl>
<dd>

**reason:** `BillingCreditGrantReason` 
    
</dd>
</dl>

<dl>
<dd>

**renewalEnabled:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**renewalPeriod:** `Optional<BillingPlanCreditGrantResetStart>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.countCompanyGrants() -> CountCompanyGrantsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().countCompanyGrants(
    CountCompanyGrantsRequest
        .builder()
        .companyId("company_id")
        .order(CreditGrantSortOrder.CREATED_AT)
        .dir(SortDirection.ASC)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**order:** `Optional<CreditGrantSortOrder>` 
    
</dd>
</dl>

<dl>
<dd>

**dir:** `Optional<SortDirection>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.listCompanyGrants() -> ListCompanyGrantsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().listCompanyGrants(
    ListCompanyGrantsRequest
        .builder()
        .companyId("company_id")
        .order(CreditGrantSortOrder.CREATED_AT)
        .dir(SortDirection.ASC)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**order:** `Optional<CreditGrantSortOrder>` 
    
</dd>
</dl>

<dl>
<dd>

**dir:** `Optional<SortDirection>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.countBillingCreditsGrants() -> CountBillingCreditsGrantsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().countBillingCreditsGrants(
    CountBillingCreditsGrantsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .creditId("credit_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.listGrantsForCredit() -> ListGrantsForCreditResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().listGrantsForCredit(
    ListGrantsForCreditRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .creditId("credit_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.acquireCreditLease(request) -> AcquireCreditLeaseResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().acquireCreditLease(
    AcquireCreditLeaseRequestBody
        .builder()
        .companyId("company_id")
        .creditTypeId("credit_type_id")
        .requestedAmount(1.1)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**creditTypeId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**expiresAt:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**requestedAmount:** `Double` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.extendCreditLease(leaseId, request) -> ExtendCreditLeaseResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().extendCreditLease(
    "lease_id",
    ExtendCreditLeaseRequestBody
        .builder()
        .additionalAmount(1.1)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**leaseId:** `String` — lease_id
    
</dd>
</dl>

<dl>
<dd>

**additionalAmount:** `Double` 
    
</dd>
</dl>

<dl>
<dd>

**expiresAt:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.releaseCreditLease(leaseId, request) -> ReleaseCreditLeaseResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().releaseCreditLease(
    "lease_id",
    new HashMap<String, JsonNode>() {{
        put("key", ObjectMappers.JSON_MAPPER.valueToTree("value"));
    }}
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**leaseId:** `String` — lease_id
    
</dd>
</dl>

<dl>
<dd>

**request:** `Map<String, Object>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.getEnrichedCreditLedger() -> GetEnrichedCreditLedgerResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().getEnrichedCreditLedger(
    GetEnrichedCreditLedgerRequest
        .builder()
        .companyId("company_id")
        .period(CreditLedgerPeriod.DAILY)
        .billingCreditId("billing_credit_id")
        .featureId("feature_id")
        .startTime("start_time")
        .endTime("end_time")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**billingCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**period:** `CreditLedgerPeriod` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**endTime:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.countCreditLedger() -> CountCreditLedgerResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().countCreditLedger(
    CountCreditLedgerRequest
        .builder()
        .companyId("company_id")
        .period(CreditLedgerPeriod.DAILY)
        .billingCreditId("billing_credit_id")
        .featureId("feature_id")
        .startTime("start_time")
        .endTime("end_time")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**billingCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**period:** `CreditLedgerPeriod` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**endTime:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.listBillingPlanCreditGrants() -> ListBillingPlanCreditGrantsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().listBillingPlanCreditGrants(
    ListBillingPlanCreditGrantsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .planIds(
            Arrays.asList("plan_ids")
        )
        .planVersionIds(
            Arrays.asList("plan_version_ids")
        )
        .creditId("credit_id")
        .planId("plan_id")
        .planVersionId("plan_version_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.createBillingPlanCreditGrant(request) -> CreateBillingPlanCreditGrantResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().createBillingPlanCreditGrant(
    CreateBillingPlanCreditGrantRequestBody
        .builder()
        .creditAmount(1000000L)
        .creditId("credit_id")
        .planId("plan_id")
        .resetCadence(BillingPlanCreditGrantResetCadence.DAILY)
        .resetStart(BillingPlanCreditGrantResetStart.BILLING_PERIOD)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `CreateBillingPlanCreditGrantRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.getSingleBillingPlanCreditGrant(planGrantId) -> GetSingleBillingPlanCreditGrantResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().getSingleBillingPlanCreditGrant("plan_grant_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planGrantId:** `String` — plan_grant_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.updateBillingPlanCreditGrant(planGrantId, request) -> UpdateBillingPlanCreditGrantResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().updateBillingPlanCreditGrant(
    "plan_grant_id",
    UpdateBillingPlanCreditGrantRequestBody
        .builder()
        .resetCadence(BillingPlanCreditGrantResetCadence.DAILY)
        .resetStart(BillingPlanCreditGrantResetStart.BILLING_PERIOD)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planGrantId:** `String` — plan_grant_id
    
</dd>
</dl>

<dl>
<dd>

**request:** `UpdateBillingPlanCreditGrantRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.deleteBillingPlanCreditGrant(planGrantId) -> DeleteBillingPlanCreditGrantResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().deleteBillingPlanCreditGrant(
    "plan_grant_id",
    DeleteBillingPlanCreditGrantRequest
        .builder()
        .applyToExisting(true)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planGrantId:** `String` — plan_grant_id
    
</dd>
</dl>

<dl>
<dd>

**applyToExisting:** `Optional<Boolean>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.countBillingPlanCreditGrants() -> CountBillingPlanCreditGrantsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().countBillingPlanCreditGrants(
    CountBillingPlanCreditGrantsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .planIds(
            Arrays.asList("plan_ids")
        )
        .planVersionIds(
            Arrays.asList("plan_version_ids")
        )
        .creditId("credit_id")
        .planId("plan_id")
        .planVersionId("plan_version_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.listCreditEventLedger() -> ListCreditEventLedgerResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().listCreditEventLedger(
    ListCreditEventLedgerRequest
        .builder()
        .companyId("company_id")
        .billingCreditId("billing_credit_id")
        .endTime("end_time")
        .eventType(CreditEventType.GRANT)
        .featureId("feature_id")
        .startTime("start_time")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**endTime:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**eventType:** `Optional<CreditEventType>` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.credits.countCreditEventLedger() -> CountCreditEventLedgerResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.credits().countCreditEventLedger(
    CountCreditEventLedgerRequest
        .builder()
        .companyId("company_id")
        .billingCreditId("billing_credit_id")
        .endTime("end_time")
        .eventType(CreditEventType.GRANT)
        .featureId("feature_id")
        .startTime("start_time")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**endTime:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**eventType:** `Optional<CreditEventType>` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## checkout
<details><summary><code>client.checkout.internal(request) -> CheckoutInternalResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.checkout().internal(
    ChangeSubscriptionInternalRequestBody
        .builder()
        .companyId("company_id")
        .newPlanId("new_plan_id")
        .newPriceId("new_price_id")
        .skipTrial(true)
        .addOnIds(
            Arrays.asList(
                UpdateAddOnRequestBody
                    .builder()
                    .addOnId("add_on_id")
                    .priceId("price_id")
                    .build()
            )
        )
        .autoTopupOverrides(
            Arrays.asList(
                UpdateAutoTopupOverrideRequestBody
                    .builder()
                    .planCreditGrantId("plan_credit_grant_id")
                    .build()
            )
        )
        .creditBundles(
            Arrays.asList(
                UpdateCreditBundleRequestBody
                    .builder()
                    .bundleId("bundle_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .payInAdvance(
            Arrays.asList(
                UpdatePayInAdvanceRequestBody
                    .builder()
                    .priceId("price_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `ChangeSubscriptionInternalRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.checkout.getCheckoutData(request) -> GetCheckoutDataResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.checkout().getCheckoutData(
    CheckoutDataRequestBody
        .builder()
        .companyId("company_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**selectedPlanId:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.checkout.previewCheckoutInternal(request) -> PreviewCheckoutInternalResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.checkout().previewCheckoutInternal(
    ChangeSubscriptionInternalRequestBody
        .builder()
        .companyId("company_id")
        .newPlanId("new_plan_id")
        .newPriceId("new_price_id")
        .skipTrial(true)
        .addOnIds(
            Arrays.asList(
                UpdateAddOnRequestBody
                    .builder()
                    .addOnId("add_on_id")
                    .priceId("price_id")
                    .build()
            )
        )
        .autoTopupOverrides(
            Arrays.asList(
                UpdateAutoTopupOverrideRequestBody
                    .builder()
                    .planCreditGrantId("plan_credit_grant_id")
                    .build()
            )
        )
        .creditBundles(
            Arrays.asList(
                UpdateCreditBundleRequestBody
                    .builder()
                    .bundleId("bundle_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .payInAdvance(
            Arrays.asList(
                UpdatePayInAdvanceRequestBody
                    .builder()
                    .priceId("price_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `ChangeSubscriptionInternalRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.checkout.managePlan(request) -> ManagePlanResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.checkout().managePlan(
    ManagePlanRequest
        .builder()
        .companyId("company_id")
        .addOnSelections(
            Arrays.asList(
                PlanSelection
                    .builder()
                    .planId("plan_id")
                    .build()
            )
        )
        .creditBundles(
            Arrays.asList(
                UpdateCreditBundleRequestBody
                    .builder()
                    .bundleId("bundle_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .payInAdvanceEntitlements(
            Arrays.asList(
                UpdatePayInAdvanceRequestBody
                    .builder()
                    .priceId("price_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `ManagePlanRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.checkout.previewManagePlan(request) -> PreviewManagePlanResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.checkout().previewManagePlan(
    ManagePlanRequest
        .builder()
        .companyId("company_id")
        .addOnSelections(
            Arrays.asList(
                PlanSelection
                    .builder()
                    .planId("plan_id")
                    .build()
            )
        )
        .creditBundles(
            Arrays.asList(
                UpdateCreditBundleRequestBody
                    .builder()
                    .bundleId("bundle_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .payInAdvanceEntitlements(
            Arrays.asList(
                UpdatePayInAdvanceRequestBody
                    .builder()
                    .priceId("price_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `ManagePlanRequest` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.checkout.cancelSubscription(request) -> CancelSubscriptionResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.checkout().cancelSubscription(
    CancelSubscriptionRequest
        .builder()
        .companyId("company_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**cancelImmediately:** `Optional<Boolean>` — If false, subscription cancels at period end. Defaults to true.
    
</dd>
</dl>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**prorate:** `Optional<Boolean>` — If true and cancel_immediately is true, issue prorated credit. Defaults to true.
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.checkout.updateCustomerSubscriptionTrialEnd(subscriptionId, request) -> UpdateCustomerSubscriptionTrialEndResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.checkout().updateCustomerSubscriptionTrialEnd(
    "subscription_id",
    UpdateTrialEndRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**subscriptionId:** `String` — subscription_id
    
</dd>
</dl>

<dl>
<dd>

**trialEnd:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## companies
<details><summary><code>client.companies.listCompanies() -> ListCompaniesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().listCompanies(
    ListCompaniesRequest
        .builder()
        .creditTypeIds(
            Arrays.asList("credit_type_ids")
        )
        .ids(
            Arrays.asList("ids")
        )
        .planIds(
            Arrays.asList("plan_ids")
        )
        .planVersionIds(
            Arrays.asList("plan_version_ids")
        )
        .subscriptionStatuses(
            Arrays.asList(SubscriptionStatus.ACTIVE)
        )
        .subscriptionTypes(
            Arrays.asList(SubscriptionType.FREE)
        )
        .hasScheduledDowngrade(true)
        .monetizedSubscriptions(true)
        .planId("plan_id")
        .planVersionId("plan_version_id")
        .q("q")
        .sortOrderColumn("sort_order_column")
        .sortOrderDirection(SortDirection.ASC)
        .withEntitlementFor("with_entitlement_for")
        .withoutFeatureOverrideFor("without_feature_override_for")
        .withoutPlan(true)
        .withoutSubscription(true)
        .withSubscription(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditTypeIds:** `Optional<String>` — Filter companies by one or more credit type IDs (each ID starts with bcrd_)
    
</dd>
</dl>

<dl>
<dd>

**hasScheduledDowngrade:** `Optional<Boolean>` — Filter companies that have a pending scheduled downgrade
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` — Filter companies by multiple company IDs (starts with comp_)
    
</dd>
</dl>

<dl>
<dd>

**monetizedSubscriptions:** `Optional<Boolean>` — Filter companies that have monetized subscriptions
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` — Filter companies by plan ID (starts with plan_)
    
</dd>
</dl>

<dl>
<dd>

**planIds:** `Optional<String>` — Filter companies by one or more plan IDs (each ID starts with plan_)
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` — Filter companies by plan version ID (starts with plvr_)
    
</dd>
</dl>

<dl>
<dd>

**planVersionIds:** `Optional<String>` — Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set.
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for companies by name, keys or string traits
    
</dd>
</dl>

<dl>
<dd>

**sortOrderColumn:** `Optional<String>` — Column to sort by (e.g. name, created_at, last_seen_at)
    
</dd>
</dl>

<dl>
<dd>

**sortOrderDirection:** `Optional<SortDirection>` — Direction to sort by (asc or desc)
    
</dd>
</dl>

<dl>
<dd>

**subscriptionStatuses:** `Optional<SubscriptionStatus>` — Filter companies by one or more subscription statuses
    
</dd>
</dl>

<dl>
<dd>

**subscriptionTypes:** `Optional<SubscriptionType>` — Filter companies by one or more subscription types
    
</dd>
</dl>

<dl>
<dd>

**withEntitlementFor:** `Optional<String>` — Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID
    
</dd>
</dl>

<dl>
<dd>

**withoutFeatureOverrideFor:** `Optional<String>` — Filter out companies that already have a company override for the specified feature ID
    
</dd>
</dl>

<dl>
<dd>

**withoutPlan:** `Optional<Boolean>` — Filter out companies that have a plan
    
</dd>
</dl>

<dl>
<dd>

**withoutSubscription:** `Optional<Boolean>` — Filter out companies that have a subscription
    
</dd>
</dl>

<dl>
<dd>

**withSubscription:** `Optional<Boolean>` — Filter companies that have a subscription
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.upsertCompany(request) -> UpsertCompanyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().upsertCompany(
    UpsertCompanyRequestBody
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `UpsertCompanyRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getCompany(companyId) -> GetCompanyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getCompany("company_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` — company_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.deleteCompany(companyId) -> DeleteCompanyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().deleteCompany(
    "company_id",
    DeleteCompanyRequest
        .builder()
        .cancelSubscription(true)
        .prorate(true)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` — company_id
    
</dd>
</dl>

<dl>
<dd>

**cancelSubscription:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**prorate:** `Optional<Boolean>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.countCompanies() -> CountCompaniesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().countCompanies(
    CountCompaniesRequest
        .builder()
        .creditTypeIds(
            Arrays.asList("credit_type_ids")
        )
        .ids(
            Arrays.asList("ids")
        )
        .planIds(
            Arrays.asList("plan_ids")
        )
        .planVersionIds(
            Arrays.asList("plan_version_ids")
        )
        .subscriptionStatuses(
            Arrays.asList(SubscriptionStatus.ACTIVE)
        )
        .subscriptionTypes(
            Arrays.asList(SubscriptionType.FREE)
        )
        .hasScheduledDowngrade(true)
        .monetizedSubscriptions(true)
        .planId("plan_id")
        .planVersionId("plan_version_id")
        .q("q")
        .sortOrderColumn("sort_order_column")
        .sortOrderDirection(SortDirection.ASC)
        .withEntitlementFor("with_entitlement_for")
        .withoutFeatureOverrideFor("without_feature_override_for")
        .withoutPlan(true)
        .withoutSubscription(true)
        .withSubscription(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditTypeIds:** `Optional<String>` — Filter companies by one or more credit type IDs (each ID starts with bcrd_)
    
</dd>
</dl>

<dl>
<dd>

**hasScheduledDowngrade:** `Optional<Boolean>` — Filter companies that have a pending scheduled downgrade
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` — Filter companies by multiple company IDs (starts with comp_)
    
</dd>
</dl>

<dl>
<dd>

**monetizedSubscriptions:** `Optional<Boolean>` — Filter companies that have monetized subscriptions
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` — Filter companies by plan ID (starts with plan_)
    
</dd>
</dl>

<dl>
<dd>

**planIds:** `Optional<String>` — Filter companies by one or more plan IDs (each ID starts with plan_)
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` — Filter companies by plan version ID (starts with plvr_)
    
</dd>
</dl>

<dl>
<dd>

**planVersionIds:** `Optional<String>` — Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set.
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for companies by name, keys or string traits
    
</dd>
</dl>

<dl>
<dd>

**sortOrderColumn:** `Optional<String>` — Column to sort by (e.g. name, created_at, last_seen_at)
    
</dd>
</dl>

<dl>
<dd>

**sortOrderDirection:** `Optional<SortDirection>` — Direction to sort by (asc or desc)
    
</dd>
</dl>

<dl>
<dd>

**subscriptionStatuses:** `Optional<SubscriptionStatus>` — Filter companies by one or more subscription statuses
    
</dd>
</dl>

<dl>
<dd>

**subscriptionTypes:** `Optional<SubscriptionType>` — Filter companies by one or more subscription types
    
</dd>
</dl>

<dl>
<dd>

**withEntitlementFor:** `Optional<String>` — Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID
    
</dd>
</dl>

<dl>
<dd>

**withoutFeatureOverrideFor:** `Optional<String>` — Filter out companies that already have a company override for the specified feature ID
    
</dd>
</dl>

<dl>
<dd>

**withoutPlan:** `Optional<Boolean>` — Filter out companies that have a plan
    
</dd>
</dl>

<dl>
<dd>

**withoutSubscription:** `Optional<Boolean>` — Filter out companies that have a subscription
    
</dd>
</dl>

<dl>
<dd>

**withSubscription:** `Optional<Boolean>` — Filter companies that have a subscription
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.createCompany(request) -> CreateCompanyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().createCompany(
    UpsertCompanyRequestBody
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `UpsertCompanyRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.deleteCompanyByKeys(request) -> DeleteCompanyByKeysResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().deleteCompanyByKeys(
    KeysRequestBody
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `KeysRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.lookupCompany() -> LookupCompanyResponse</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Company lookup is determined to resolve a company from its keys, similar to how many of our other apis work. 
The following approaches will all work to resolve a company and any of them are appropriate:
1. `/companies/lookup?keys={"foo": "bar", "fizz": "buzz"}`
2. `/companies/lookup?keys[foo]=bar&keys[fizz]=buzz`
2. `/companies/lookup?foo=bar&fizz=buzz`
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().lookupCompany(
    LookupCompanyRequest
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("keys", "keys");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**keys:** `Map<String, String>` — Key/value pairs
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.listCompanyMemberships() -> ListCompanyMembershipsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().listCompanyMemberships(
    ListCompanyMembershipsRequest
        .builder()
        .companyId("company_id")
        .userId("user_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**userId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getOrCreateCompanyMembership(request) -> GetOrCreateCompanyMembershipResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getOrCreateCompanyMembership(
    GetOrCreateCompanyMembershipRequestBody
        .builder()
        .companyId("company_id")
        .userId("user_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**userId:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.deleteCompanyMembership(companyMembershipId) -> DeleteCompanyMembershipResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().deleteCompanyMembership("company_membership_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyMembershipId:** `String` — company_membership_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getActiveCompanySubscription() -> GetActiveCompanySubscriptionResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getActiveCompanySubscription(
    GetActiveCompanySubscriptionRequest
        .builder()
        .companyIds(
            Arrays.asList("company_ids")
        )
        .companyId("company_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**companyIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.upsertCompanyTrait(request) -> UpsertCompanyTraitResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().upsertCompanyTrait(
    UpsertTraitRequestBody
        .builder()
        .trait("trait")
        .keys(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `UpsertTraitRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.listEntityKeyDefinitions() -> ListEntityKeyDefinitionsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().listEntityKeyDefinitions(
    ListEntityKeyDefinitionsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .entityType(EntityType.COMPANY)
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**entityType:** `Optional<EntityType>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.countEntityKeyDefinitions() -> CountEntityKeyDefinitionsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().countEntityKeyDefinitions(
    CountEntityKeyDefinitionsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .entityType(EntityType.COMPANY)
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**entityType:** `Optional<EntityType>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.listEntityTraitDefinitions() -> ListEntityTraitDefinitionsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().listEntityTraitDefinitions(
    ListEntityTraitDefinitionsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .traitTypes(
            Arrays.asList(TraitType.BOOLEAN)
        )
        .entityType(EntityType.COMPANY)
        .q("q")
        .traitType(TraitType.BOOLEAN)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**entityType:** `Optional<EntityType>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitType:** `Optional<TraitType>` 
    
</dd>
</dl>

<dl>
<dd>

**traitTypes:** `Optional<TraitType>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getOrCreateEntityTraitDefinition(request) -> GetOrCreateEntityTraitDefinitionResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getOrCreateEntityTraitDefinition(
    CreateEntityTraitDefinitionRequestBody
        .builder()
        .entityType(EntityType.COMPANY)
        .traitType(TraitType.BOOLEAN)
        .hierarchy(
            Arrays.asList("hierarchy")
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**displayName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**entityType:** `EntityType` 
    
</dd>
</dl>

<dl>
<dd>

**hierarchy:** `List<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitType:** `TraitType` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getEntityTraitDefinition(entityTraitDefinitionId) -> GetEntityTraitDefinitionResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getEntityTraitDefinition("entity_trait_definition_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**entityTraitDefinitionId:** `String` — entity_trait_definition_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.updateEntityTraitDefinition(entityTraitDefinitionId, request) -> UpdateEntityTraitDefinitionResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().updateEntityTraitDefinition(
    "entity_trait_definition_id",
    UpdateEntityTraitDefinitionRequestBody
        .builder()
        .traitType(TraitType.BOOLEAN)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**entityTraitDefinitionId:** `String` — entity_trait_definition_id
    
</dd>
</dl>

<dl>
<dd>

**displayName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitType:** `TraitType` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.countEntityTraitDefinitions() -> CountEntityTraitDefinitionsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().countEntityTraitDefinitions(
    CountEntityTraitDefinitionsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .traitTypes(
            Arrays.asList(TraitType.BOOLEAN)
        )
        .entityType(EntityType.COMPANY)
        .q("q")
        .traitType(TraitType.BOOLEAN)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**entityType:** `Optional<EntityType>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitType:** `Optional<TraitType>` 
    
</dd>
</dl>

<dl>
<dd>

**traitTypes:** `Optional<TraitType>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getEntityTraitValues() -> GetEntityTraitValuesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getEntityTraitValues(
    GetEntityTraitValuesRequest
        .builder()
        .definitionId("definition_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**definitionId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.listPlanChanges() -> ListPlanChangesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().listPlanChanges(
    ListPlanChangesRequest
        .builder()
        .companyIds(
            Arrays.asList("company_ids")
        )
        .planIds(
            Arrays.asList("plan_ids")
        )
        .action(PlanChangeAction.CHECKOUT)
        .basePlanAction(PlanChangeBasePlanAction.FALLBACK)
        .companyId("company_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**action:** `Optional<PlanChangeAction>` 
    
</dd>
</dl>

<dl>
<dd>

**basePlanAction:** `Optional<PlanChangeBasePlanAction>` 
    
</dd>
</dl>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**companyIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getPlanChange(planChangeId) -> GetPlanChangeResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getPlanChange("plan_change_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planChangeId:** `String` — plan_change_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.listPlanTraits() -> ListPlanTraitsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().listPlanTraits(
    ListPlanTraitsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .traitIds(
            Arrays.asList("trait_ids")
        )
        .planId("plan_id")
        .traitId("trait_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getPlanTrait(planTraitId) -> GetPlanTraitResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getPlanTrait("plan_trait_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planTraitId:** `String` — plan_trait_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.updatePlanTraitsBulk(request) -> UpdatePlanTraitsBulkResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().updatePlanTraitsBulk(
    UpdatePlanTraitBulkRequestBody
        .builder()
        .applyToExistingCompanies(true)
        .planId("plan_id")
        .traits(
            Arrays.asList(
                UpdatePlanTraitTraitRequestBody
                    .builder()
                    .traitId("trait_id")
                    .traitValue("trait_value")
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**applyToExistingCompanies:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**planId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**traits:** `List<UpdatePlanTraitTraitRequestBody>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.countPlanTraits() -> CountPlanTraitsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().countPlanTraits(
    CountPlanTraitsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .traitIds(
            Arrays.asList("trait_ids")
        )
        .planId("plan_id")
        .traitId("trait_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.upsertUserTrait(request) -> UpsertUserTraitResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().upsertUserTrait(
    UpsertTraitRequestBody
        .builder()
        .trait("trait")
        .keys(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `UpsertTraitRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.listUsers() -> ListUsersResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().listUsers(
    ListUsersRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .companyId("company_id")
        .planId("plan_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` — Filter users by company ID (starts with comp_)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` — Filter users by multiple user IDs (starts with user_)
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` — Filter users by plan ID (starts with plan_)
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for users by name, keys or string traits
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.upsertUser(request) -> UpsertUserResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().upsertUser(
    UpsertUserRequestBody
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `UpsertUserRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.getUser(userId) -> GetUserResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().getUser("user_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**userId:** `String` — user_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.deleteUser(userId) -> DeleteUserResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().deleteUser("user_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**userId:** `String` — user_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.countUsers() -> CountUsersResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().countUsers(
    CountUsersRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .companyId("company_id")
        .planId("plan_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` — Filter users by company ID (starts with comp_)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` — Filter users by multiple user IDs (starts with user_)
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` — Filter users by plan ID (starts with plan_)
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for users by name, keys or string traits
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.createUser(request) -> CreateUserResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().createUser(
    UpsertUserRequestBody
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `UpsertUserRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.deleteUserByKeys(request) -> DeleteUserByKeysResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().deleteUserByKeys(
    KeysRequestBody
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `KeysRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.companies.lookupUser() -> LookupUserResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.companies().lookupUser(
    LookupUserRequest
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("keys", "keys");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**keys:** `Map<String, String>` — Key/value pairs
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## entitlements
<details><summary><code>client.entitlements.listCompanyOverrides() -> ListCompanyOverridesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().listCompanyOverrides(
    ListCompanyOverridesRequest
        .builder()
        .companyIds(
            Arrays.asList("company_ids")
        )
        .featureIds(
            Arrays.asList("feature_ids")
        )
        .ids(
            Arrays.asList("ids")
        )
        .companyId("company_id")
        .featureId("feature_id")
        .withoutExpired(true)
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` — Filter company overrides by a single company ID (starting with comp_)
    
</dd>
</dl>

<dl>
<dd>

**companyIds:** `Optional<String>` — Filter company overrides by multiple company IDs (starting with comp_)
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `Optional<String>` — Filter company overrides by a single feature ID (starting with feat_)
    
</dd>
</dl>

<dl>
<dd>

**featureIds:** `Optional<String>` — Filter company overrides by multiple feature IDs (starting with feat_)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` — Filter company overrides by multiple company override IDs (starting with cmov_)
    
</dd>
</dl>

<dl>
<dd>

**withoutExpired:** `Optional<Boolean>` — Filter company overrides by whether they have not expired
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for company overrides by feature or company name
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.createCompanyOverride(request) -> CreateCompanyOverrideResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().createCompanyOverride(
    CreateCompanyOverrideRequestBody
        .builder()
        .companyId("company_id")
        .featureId("feature_id")
        .valueType(EntitlementValueType.BOOLEAN)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**creditConsumptionRate:** `Optional<Double>` 
    
</dd>
</dl>

<dl>
<dd>

**expirationDate:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriod:** `Optional<MetricPeriod>` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriodMonthReset:** `Optional<MetricPeriodMonthReset>` 
    
</dd>
</dl>

<dl>
<dd>

**note:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueBool:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**valueCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueNumeric:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**valueTraitId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueType:** `EntitlementValueType` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.getCompanyOverride(companyOverrideId) -> GetCompanyOverrideResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().getCompanyOverride("company_override_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyOverrideId:** `String` — company_override_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.updateCompanyOverride(companyOverrideId, request) -> UpdateCompanyOverrideResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().updateCompanyOverride(
    "company_override_id",
    UpdateCompanyOverrideRequestBody
        .builder()
        .valueType(EntitlementValueType.BOOLEAN)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyOverrideId:** `String` — company_override_id
    
</dd>
</dl>

<dl>
<dd>

**creditConsumptionRate:** `Optional<Double>` 
    
</dd>
</dl>

<dl>
<dd>

**expirationDate:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriod:** `Optional<MetricPeriod>` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriodMonthReset:** `Optional<MetricPeriodMonthReset>` 
    
</dd>
</dl>

<dl>
<dd>

**note:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueBool:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**valueCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueNumeric:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**valueTraitId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueType:** `EntitlementValueType` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.deleteCompanyOverride(companyOverrideId) -> DeleteCompanyOverrideResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().deleteCompanyOverride("company_override_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyOverrideId:** `String` — company_override_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.countCompanyOverrides() -> CountCompanyOverridesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().countCompanyOverrides(
    CountCompanyOverridesRequest
        .builder()
        .companyIds(
            Arrays.asList("company_ids")
        )
        .featureIds(
            Arrays.asList("feature_ids")
        )
        .ids(
            Arrays.asList("ids")
        )
        .companyId("company_id")
        .featureId("feature_id")
        .withoutExpired(true)
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` — Filter company overrides by a single company ID (starting with comp_)
    
</dd>
</dl>

<dl>
<dd>

**companyIds:** `Optional<String>` — Filter company overrides by multiple company IDs (starting with comp_)
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `Optional<String>` — Filter company overrides by a single feature ID (starting with feat_)
    
</dd>
</dl>

<dl>
<dd>

**featureIds:** `Optional<String>` — Filter company overrides by multiple feature IDs (starting with feat_)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` — Filter company overrides by multiple company override IDs (starting with cmov_)
    
</dd>
</dl>

<dl>
<dd>

**withoutExpired:** `Optional<Boolean>` — Filter company overrides by whether they have not expired
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for company overrides by feature or company name
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.listFeatureCompanies() -> ListFeatureCompaniesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().listFeatureCompanies(
    ListFeatureCompaniesRequest
        .builder()
        .featureId("feature_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.countFeatureCompanies() -> CountFeatureCompaniesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().countFeatureCompanies(
    CountFeatureCompaniesRequest
        .builder()
        .featureId("feature_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.listFeatureUsage() -> ListFeatureUsageResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().listFeatureUsage(
    ListFeatureUsageRequest
        .builder()
        .featureIds(
            Arrays.asList("feature_ids")
        )
        .companyId("company_id")
        .includeUsageAggregation(true)
        .managedBy(BillingProviderType.ORB)
        .q("q")
        .withoutNegativeEntitlements(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**companyKeys:** `Optional<Map<String, String>>` 
    
</dd>
</dl>

<dl>
<dd>

**featureIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**includeUsageAggregation:** `Optional<Boolean>` — Include time-bucketed usage aggregation (today, this week, this month, billing period) for credit-based entitlements. Defaults to false for performance.
    
</dd>
</dl>

<dl>
<dd>

**managedBy:** `Optional<BillingProviderType>` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**withoutNegativeEntitlements:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.getFeatureUsageTimeSeries() -> GetFeatureUsageTimeSeriesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().getFeatureUsageTimeSeries(
    GetFeatureUsageTimeSeriesRequest
        .builder()
        .companyId("company_id")
        .endTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .featureId("feature_id")
        .startTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .granularity(TimeSeriesGranularity.DAILY)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**endTime:** `OffsetDateTime` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**granularity:** `Optional<TimeSeriesGranularity>` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `OffsetDateTime` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.countFeatureUsage() -> CountFeatureUsageResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().countFeatureUsage(
    CountFeatureUsageRequest
        .builder()
        .featureIds(
            Arrays.asList("feature_ids")
        )
        .companyId("company_id")
        .includeUsageAggregation(true)
        .managedBy(BillingProviderType.ORB)
        .q("q")
        .withoutNegativeEntitlements(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**companyKeys:** `Optional<Map<String, String>>` 
    
</dd>
</dl>

<dl>
<dd>

**featureIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**includeUsageAggregation:** `Optional<Boolean>` — Include time-bucketed usage aggregation (today, this week, this month, billing period) for credit-based entitlements. Defaults to false for performance.
    
</dd>
</dl>

<dl>
<dd>

**managedBy:** `Optional<BillingProviderType>` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**withoutNegativeEntitlements:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.listFeatureUsers() -> ListFeatureUsersResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().listFeatureUsers(
    ListFeatureUsersRequest
        .builder()
        .featureId("feature_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.countFeatureUsers() -> CountFeatureUsersResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().countFeatureUsers(
    CountFeatureUsersRequest
        .builder()
        .featureId("feature_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.listPlanEntitlements() -> ListPlanEntitlementsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().listPlanEntitlements(
    ListPlanEntitlementsRequest
        .builder()
        .featureIds(
            Arrays.asList("feature_ids")
        )
        .ids(
            Arrays.asList("ids")
        )
        .planIds(
            Arrays.asList("plan_ids")
        )
        .planVersionIds(
            Arrays.asList("plan_version_ids")
        )
        .featureId("feature_id")
        .planId("plan_id")
        .planVersionId("plan_version_id")
        .q("q")
        .withMeteredProducts(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `Optional<String>` — Filter plan entitlements by a single feature ID (starting with feat_)
    
</dd>
</dl>

<dl>
<dd>

**featureIds:** `Optional<String>` — Filter plan entitlements by multiple feature IDs (starting with feat_)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` — Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` — Filter plan entitlements by a single plan ID (starting with plan_)
    
</dd>
</dl>

<dl>
<dd>

**planIds:** `Optional<String>` — Filter plan entitlements by multiple plan IDs (starting with plan_)
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` — Filter plan entitlements by a single plan version ID (starting with plvr_)
    
</dd>
</dl>

<dl>
<dd>

**planVersionIds:** `Optional<String>` — Filter plan entitlements by multiple plan version IDs (starting with plvr_)
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for plan entitlements by feature or company name
    
</dd>
</dl>

<dl>
<dd>

**withMeteredProducts:** `Optional<Boolean>` — Filter plan entitlements only with metered products
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.createPlanEntitlement(request) -> CreatePlanEntitlementResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().createPlanEntitlement(
    CreatePlanEntitlementRequestBody
        .builder()
        .featureId("feature_id")
        .planId("plan_id")
        .valueType(EntitlementValueType.BOOLEAN)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingProductId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**billingThreshold:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**creditConsumptionRate:** `Optional<Double>` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**currencyPrices:** `Optional<List<CurrencyPriceRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriod:** `Optional<MetricPeriod>` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriodMonthReset:** `Optional<MetricPeriodMonthReset>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**overageBillingProductId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**priceBehavior:** `Optional<EntitlementPriceBehavior>` 
    
</dd>
</dl>

<dl>
<dd>

**priceTiers:** `Optional<List<CreatePriceTierRequestBody>>` — Use MonthlyPriceTiers or YearlyPriceTiers instead
    
</dd>
</dl>

<dl>
<dd>

**quarterlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**softLimit:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**tierMode:** `Optional<BillingTiersMode>` 
    
</dd>
</dl>

<dl>
<dd>

**usageQuantity:** `Optional<Long>` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
    
</dd>
</dl>

<dl>
<dd>

**valueBool:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**valueCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueNumeric:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**valueTraitId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueType:** `EntitlementValueType` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.getPlanEntitlement(planEntitlementId) -> GetPlanEntitlementResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().getPlanEntitlement("plan_entitlement_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planEntitlementId:** `String` — plan_entitlement_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.updatePlanEntitlement(planEntitlementId, request) -> UpdatePlanEntitlementResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().updatePlanEntitlement(
    "plan_entitlement_id",
    UpdatePlanEntitlementRequestBody
        .builder()
        .valueType(EntitlementValueType.BOOLEAN)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planEntitlementId:** `String` — plan_entitlement_id
    
</dd>
</dl>

<dl>
<dd>

**billingProductId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**billingThreshold:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**creditConsumptionRate:** `Optional<Double>` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**currencyPrices:** `Optional<List<CurrencyPriceRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriod:** `Optional<MetricPeriod>` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriodMonthReset:** `Optional<MetricPeriodMonthReset>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**overageBillingProductId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**priceBehavior:** `Optional<EntitlementPriceBehavior>` 
    
</dd>
</dl>

<dl>
<dd>

**priceTiers:** `Optional<List<CreatePriceTierRequestBody>>` — Use MonthlyPriceTiers or YearlyPriceTiers instead
    
</dd>
</dl>

<dl>
<dd>

**quarterlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**softLimit:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**tierMode:** `Optional<BillingTiersMode>` 
    
</dd>
</dl>

<dl>
<dd>

**usageQuantity:** `Optional<Long>` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
    
</dd>
</dl>

<dl>
<dd>

**valueBool:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**valueCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueNumeric:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**valueTraitId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueType:** `EntitlementValueType` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.deletePlanEntitlement(planEntitlementId) -> DeletePlanEntitlementResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().deletePlanEntitlement("plan_entitlement_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planEntitlementId:** `String` — plan_entitlement_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.upsertPlanEntitlementForBillingProduct(request) -> UpsertPlanEntitlementForBillingProductResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().upsertPlanEntitlementForBillingProduct(
    CreateBillingLinkedPlanEntitlementRequestBody
        .builder()
        .billingProvider(BillingProviderType.ORB)
        .externalResourceId("external_resource_id")
        .featureId("feature_id")
        .planId("plan_id")
        .valueType(EntitlementValueType.BOOLEAN)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingProductId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**billingProvider:** `BillingProviderType` 
    
</dd>
</dl>

<dl>
<dd>

**billingThreshold:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**creditConsumptionRate:** `Optional<Double>` 
    
</dd>
</dl>

<dl>
<dd>

**currency:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**currencyPrices:** `Optional<List<CurrencyPriceRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**externalResourceId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriod:** `Optional<MetricPeriod>` 
    
</dd>
</dl>

<dl>
<dd>

**metricPeriodMonthReset:** `Optional<MetricPeriodMonthReset>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**monthlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**overageBillingProductId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**priceBehavior:** `Optional<EntitlementPriceBehavior>` 
    
</dd>
</dl>

<dl>
<dd>

**priceTiers:** `Optional<List<CreatePriceTierRequestBody>>` — Use MonthlyPriceTiers or YearlyPriceTiers instead
    
</dd>
</dl>

<dl>
<dd>

**quarterlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**quarterlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**softLimit:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**tierMode:** `Optional<BillingTiersMode>` 
    
</dd>
</dl>

<dl>
<dd>

**usageQuantity:** `Optional<Long>` — The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use.
    
</dd>
</dl>

<dl>
<dd>

**valueBool:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**valueCreditId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueNumeric:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**valueTraitId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**valueType:** `EntitlementValueType` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyMeteredPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyPriceTiers:** `Optional<List<CreatePriceTierRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyUnitPrice:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**yearlyUnitPriceDecimal:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.countPlanEntitlements() -> CountPlanEntitlementsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().countPlanEntitlements(
    CountPlanEntitlementsRequest
        .builder()
        .featureIds(
            Arrays.asList("feature_ids")
        )
        .ids(
            Arrays.asList("ids")
        )
        .planIds(
            Arrays.asList("plan_ids")
        )
        .planVersionIds(
            Arrays.asList("plan_version_ids")
        )
        .featureId("feature_id")
        .planId("plan_id")
        .planVersionId("plan_version_id")
        .q("q")
        .withMeteredProducts(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `Optional<String>` — Filter plan entitlements by a single feature ID (starting with feat_)
    
</dd>
</dl>

<dl>
<dd>

**featureIds:** `Optional<String>` — Filter plan entitlements by multiple feature IDs (starting with feat_)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` — Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` — Filter plan entitlements by a single plan ID (starting with plan_)
    
</dd>
</dl>

<dl>
<dd>

**planIds:** `Optional<String>` — Filter plan entitlements by multiple plan IDs (starting with plan_)
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` — Filter plan entitlements by a single plan version ID (starting with plvr_)
    
</dd>
</dl>

<dl>
<dd>

**planVersionIds:** `Optional<String>` — Filter plan entitlements by multiple plan version IDs (starting with plvr_)
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for plan entitlements by feature or company name
    
</dd>
</dl>

<dl>
<dd>

**withMeteredProducts:** `Optional<Boolean>` — Filter plan entitlements only with metered products
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.duplicatePlanEntitlements(request) -> DuplicatePlanEntitlementsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().duplicatePlanEntitlements(
    DuplicatePlanEntitlementsRequestBody
        .builder()
        .sourcePlanId("source_plan_id")
        .targetPlanId("target_plan_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**sourcePlanId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**targetPlanId:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.entitlements.getFeatureUsageByCompany() -> GetFeatureUsageByCompanyResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.entitlements().getFeatureUsageByCompany(
    GetFeatureUsageByCompanyRequest
        .builder()
        .keys(
            new HashMap<String, String>() {{
                put("keys", "keys");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**keys:** `Map<String, String>` — Key/value pairs
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## plans
<details><summary><code>client.plans.updateCompanyPlans(companyPlanId, request) -> UpdateCompanyPlansResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().updateCompanyPlans(
    "company_plan_id",
    UpdateCompanyPlansRequestBody
        .builder()
        .addOnIds(
            Arrays.asList("add_on_ids")
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyPlanId:** `String` — company_plan_id
    
</dd>
</dl>

<dl>
<dd>

**addOnIds:** `List<String>` 
    
</dd>
</dl>

<dl>
<dd>

**basePlanId:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.listCustomPlanBillings() -> ListCustomPlanBillingsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().listCustomPlanBillings(
    ListCustomPlanBillingsRequest
        .builder()
        .statuses(
            Arrays.asList(CustomPlanBillingStatus.ACTIVE)
        )
        .companyId("company_id")
        .planId("plan_id")
        .status(CustomPlanBillingStatus.ACTIVE)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` — Filter by company ID
    
</dd>
</dl>

<dl>
<dd>

**planId:** `Optional<String>` — Filter by plan ID
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<CustomPlanBillingStatus>` — Filter by billing status
    
</dd>
</dl>

<dl>
<dd>

**statuses:** `Optional<CustomPlanBillingStatus>` — Filter by multiple billing statuses
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.markCustomPlanBillingPaid(customPlanBillingId, request) -> MarkCustomPlanBillingPaidResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().markCustomPlanBillingPaid(
    "custom_plan_billing_id",
    new HashMap<String, JsonNode>() {{
        put("key", ObjectMappers.JSON_MAPPER.valueToTree("value"));
    }}
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**customPlanBillingId:** `String` — custom_plan_billing_id
    
</dd>
</dl>

<dl>
<dd>

**request:** `Map<String, Object>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.retryCustomPlanBilling(customPlanBillingId, request) -> RetryCustomPlanBillingResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().retryCustomPlanBilling(
    "custom_plan_billing_id",
    RetryCustomPlanBillingRequestBody
        .builder()
        .customerEmail("customer_email")
        .payInAdvance(
            Arrays.asList(
                UpdatePayInAdvanceRequestBody
                    .builder()
                    .priceId("price_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**customPlanBillingId:** `String` — custom_plan_billing_id
    
</dd>
</dl>

<dl>
<dd>

**activationStrategy:** `Optional<CustomPlanActivationStrategy>` 
    
</dd>
</dl>

<dl>
<dd>

**customerEmail:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**daysUntilDue:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**payInAdvance:** `List<UpdatePayInAdvanceRequestBody>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.createCustomPlan(request) -> CreateCustomPlanResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().createCustomPlan(
    CreateCustomPlanRequestBody
        .builder()
        .companyId("company_id")
        .description("description")
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**copiedFromPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**description:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**icon:** `Optional<PlanIcon>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.listPlans() -> ListPlansResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().listPlans(
    ListPlansRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .companyId("company_id")
        .companyScopedOnly(true)
        .excludeCompanyScoped(true)
        .forFallbackPlan(true)
        .forInitialPlan(true)
        .forTrialExpiryPlan(true)
        .hasProductId(true)
        .includeDraftVersions(true)
        .planType(PlanType.PLAN)
        .q("q")
        .scopedToCompanyId("scoped_to_company_id")
        .withEntitlements(true)
        .withoutEntitlementFor("without_entitlement_for")
        .withoutPaidProductId(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**companyScopedOnly:** `Optional<Boolean>` — Only return plans that are scoped to a company (custom plans assigned to a company)
    
</dd>
</dl>

<dl>
<dd>

**excludeCompanyScoped:** `Optional<Boolean>` — Exclude plans that are scoped to a company (custom plans assigned to a company)
    
</dd>
</dl>

<dl>
<dd>

**forFallbackPlan:** `Optional<Boolean>` — Filter for plans valid as fallback plans (not linked to billing)
    
</dd>
</dl>

<dl>
<dd>

**forInitialPlan:** `Optional<Boolean>` — Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)
    
</dd>
</dl>

<dl>
<dd>

**forTrialExpiryPlan:** `Optional<Boolean>` — Filter for plans valid as trial expiry plans (not linked to billing or free)
    
</dd>
</dl>

<dl>
<dd>

**hasProductId:** `Optional<Boolean>` — Filter out plans that do not have a billing product ID
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**includeDraftVersions:** `Optional<Boolean>` — Include billing settings from draft versions for plans which have draft version
    
</dd>
</dl>

<dl>
<dd>

**planType:** `Optional<PlanType>` — Filter by plan type
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**scopedToCompanyId:** `Optional<String>` — Filter plans scoped to a specific company (custom plans)
    
</dd>
</dl>

<dl>
<dd>

**withEntitlements:** `Optional<Boolean>` — Include each plan's entitlements in the response
    
</dd>
</dl>

<dl>
<dd>

**withoutEntitlementFor:** `Optional<String>` — Filter out plans that already have a plan entitlement for the specified feature ID
    
</dd>
</dl>

<dl>
<dd>

**withoutPaidProductId:** `Optional<Boolean>` — Filter out plans that have a paid billing product ID
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.createPlan(request) -> CreatePlanResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().createPlan(
    CreatePlanRequestBody
        .builder()
        .description("description")
        .name("name")
        .planType(PlanType.PLAN)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `CreatePlanRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.getPlan(planId) -> GetPlanResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().getPlan(
    "plan_id",
    GetPlanRequest
        .builder()
        .planVersionId("plan_version_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` — plan_id
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` — Fetch billing settings for a specific plan version
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.updatePlan(planId, request) -> UpdatePlanResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().updatePlan(
    "plan_id",
    UpdatePlanRequestBody
        .builder()
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` — plan_id
    
</dd>
</dl>

<dl>
<dd>

**request:** `UpdatePlanRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.deletePlan(planId) -> DeletePlanResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().deletePlan("plan_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` — plan_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.upsertBillingProductPlan(planId, request) -> UpsertBillingProductPlanResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().upsertBillingProductPlan(
    "plan_id",
    UpsertBillingProductRequestBody
        .builder()
        .chargeType(ChargeType.FREE)
        .isTrialable(true)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` — plan_id
    
</dd>
</dl>

<dl>
<dd>

**request:** `UpsertBillingProductRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.upsertPlanForBillingProduct(request) -> UpsertPlanForBillingProductResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().upsertPlanForBillingProduct(
    CreateBillingLinkedPlanRequestBody
        .builder()
        .billingProvider(BillingProviderType.ORB)
        .description("description")
        .externalResourceId("external_resource_id")
        .name("name")
        .planType(PlanType.PLAN)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingProvider:** `BillingProviderType` 
    
</dd>
</dl>

<dl>
<dd>

**description:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**externalResourceId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**externalResourceVersion:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**icon:** `Optional<PlanIcon>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**planType:** `PlanType` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.listBillingProductMatchCompanies() -> ListBillingProductMatchCompaniesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().listBillingProductMatchCompanies(
    ListBillingProductMatchCompaniesRequest
        .builder()
        .planId("plan_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` — The plan ID to find billing product match companies for
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for companies by name, keys or string traits
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.countBillingProductMatchCompanies() -> CountBillingProductMatchCompaniesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().countBillingProductMatchCompanies(
    CountBillingProductMatchCompaniesRequest
        .builder()
        .planId("plan_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` — The plan ID to find billing product match companies for
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search for companies by name, keys or string traits
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.countPlans() -> CountPlansResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().countPlans(
    CountPlansRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .companyId("company_id")
        .companyScopedOnly(true)
        .excludeCompanyScoped(true)
        .forFallbackPlan(true)
        .forInitialPlan(true)
        .forTrialExpiryPlan(true)
        .hasProductId(true)
        .includeDraftVersions(true)
        .planType(PlanType.PLAN)
        .q("q")
        .scopedToCompanyId("scoped_to_company_id")
        .withEntitlements(true)
        .withoutEntitlementFor("without_entitlement_for")
        .withoutPaidProductId(true)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**companyScopedOnly:** `Optional<Boolean>` — Only return plans that are scoped to a company (custom plans assigned to a company)
    
</dd>
</dl>

<dl>
<dd>

**excludeCompanyScoped:** `Optional<Boolean>` — Exclude plans that are scoped to a company (custom plans assigned to a company)
    
</dd>
</dl>

<dl>
<dd>

**forFallbackPlan:** `Optional<Boolean>` — Filter for plans valid as fallback plans (not linked to billing)
    
</dd>
</dl>

<dl>
<dd>

**forInitialPlan:** `Optional<Boolean>` — Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)
    
</dd>
</dl>

<dl>
<dd>

**forTrialExpiryPlan:** `Optional<Boolean>` — Filter for plans valid as trial expiry plans (not linked to billing or free)
    
</dd>
</dl>

<dl>
<dd>

**hasProductId:** `Optional<Boolean>` — Filter out plans that do not have a billing product ID
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**includeDraftVersions:** `Optional<Boolean>` — Include billing settings from draft versions for plans which have draft version
    
</dd>
</dl>

<dl>
<dd>

**planType:** `Optional<PlanType>` — Filter by plan type
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**scopedToCompanyId:** `Optional<String>` — Filter plans scoped to a specific company (custom plans)
    
</dd>
</dl>

<dl>
<dd>

**withEntitlements:** `Optional<Boolean>` — Include each plan's entitlements in the response
    
</dd>
</dl>

<dl>
<dd>

**withoutEntitlementFor:** `Optional<String>` — Filter out plans that already have a plan entitlement for the specified feature ID
    
</dd>
</dl>

<dl>
<dd>

**withoutPaidProductId:** `Optional<Boolean>` — Filter out plans that have a paid billing product ID
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.listPlanIssues() -> ListPlanIssuesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().listPlanIssues(
    ListPlanIssuesRequest
        .builder()
        .planId("plan_id")
        .planVersionId("plan_version_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.deletePlanVersion(planId) -> DeletePlanVersionResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().deletePlanVersion(
    "plan_id",
    DeletePlanVersionRequest
        .builder()
        .promoteArchivedVersion(true)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` — plan_id
    
</dd>
</dl>

<dl>
<dd>

**promoteArchivedVersion:** `Optional<Boolean>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plans.publishPlanVersion(planId, request) -> PublishPlanVersionResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plans().publishPlanVersion(
    "plan_id",
    PublishPlanVersionRequestBody
        .builder()
        .migrationStrategy(PlanVersionMigrationStrategy.IMMEDIATE)
        .excludedCompanyIds(
            Arrays.asList("excluded_company_ids")
        )
        .payInAdvance(
            Arrays.asList(
                UpdatePayInAdvanceRequestBody
                    .builder()
                    .priceId("price_id")
                    .quantity(1000000L)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planId:** `String` — plan_id
    
</dd>
</dl>

<dl>
<dd>

**activationStrategy:** `Optional<CustomPlanActivationStrategy>` 
    
</dd>
</dl>

<dl>
<dd>

**customerEmail:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**daysUntilDue:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**excludedCompanyIds:** `List<String>` 
    
</dd>
</dl>

<dl>
<dd>

**migrationStrategy:** `PlanVersionMigrationStrategy` 
    
</dd>
</dl>

<dl>
<dd>

**payInAdvance:** `List<UpdatePayInAdvanceRequestBody>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## components
<details><summary><code>client.components.listComponents() -> ListComponentsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.components().listComponents(
    ListComponentsRequest
        .builder()
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.createComponent(request) -> CreateComponentResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.components().createComponent(
    CreateComponentRequestBody
        .builder()
        .entityType(ComponentEntityType.BILLING)
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ast:** `Optional<Map<String, Double>>` 
    
</dd>
</dl>

<dl>
<dd>

**entityType:** `ComponentEntityType` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.getComponent(componentId) -> GetComponentResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.components().getComponent("component_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**componentId:** `String` — component_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.updateComponent(componentId, request) -> UpdateComponentResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.components().updateComponent(
    "component_id",
    UpdateComponentRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**componentId:** `String` — component_id
    
</dd>
</dl>

<dl>
<dd>

**ast:** `Optional<Map<String, Double>>` 
    
</dd>
</dl>

<dl>
<dd>

**entityType:** `Optional<ComponentEntityType>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**state:** `Optional<ComponentState>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.deleteComponent(componentId) -> DeleteComponentResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.components().deleteComponent("component_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**componentId:** `String` — component_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.countComponents() -> CountComponentsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.components().countComponents(
    CountComponentsRequest
        .builder()
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.components.previewComponentData() -> PreviewComponentDataResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.components().previewComponentData(
    PreviewComponentDataRequest
        .builder()
        .companyId("company_id")
        .componentId("component_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**componentId:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## planbundle
<details><summary><code>client.planbundle.createCustomPlanBundle(request) -> CreateCustomPlanBundleResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planbundle().createCustomPlanBundle(
    CreateCustomPlanBundleRequestBody
        .builder()
        .entitlements(
            Arrays.asList(
                PlanBundleEntitlementRequestBody
                    .builder()
                    .action(PlanBundleAction.CREATE)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingProduct:** `Optional<UpsertBillingProductRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**entitlements:** `List<PlanBundleEntitlementRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**plan:** `Optional<CreateCustomPlanBundlePlanRequestBody>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planbundle.createPlanBundle(request) -> CreatePlanBundleResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planbundle().createPlanBundle(
    CreatePlanBundleRequestBody
        .builder()
        .entitlements(
            Arrays.asList(
                PlanBundleEntitlementRequestBody
                    .builder()
                    .action(PlanBundleAction.CREATE)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingProduct:** `Optional<UpsertBillingProductRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**creditGrants:** `Optional<List<PlanBundleCreditGrantRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**entitlements:** `List<PlanBundleEntitlementRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**plan:** `Optional<CreatePlanRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**traits:** `Optional<List<UpdatePlanTraitTraitRequestBody>>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planbundle.updatePlanBundle(planBundleId, request) -> UpdatePlanBundleResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planbundle().updatePlanBundle(
    "plan_bundle_id",
    UpdatePlanBundleRequestBody
        .builder()
        .entitlements(
            Arrays.asList(
                PlanBundleEntitlementRequestBody
                    .builder()
                    .action(PlanBundleAction.CREATE)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planBundleId:** `String` — plan_bundle_id
    
</dd>
</dl>

<dl>
<dd>

**billingProduct:** `Optional<UpsertBillingProductRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**creditGrants:** `Optional<List<PlanBundleCreditGrantRequestBody>>` 
    
</dd>
</dl>

<dl>
<dd>

**entitlements:** `List<PlanBundleEntitlementRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**plan:** `Optional<UpdatePlanRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traits:** `Optional<List<UpdatePlanTraitTraitRequestBody>>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## dataexports
<details><summary><code>client.dataexports.createDataExport(request) -> CreateDataExportResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.dataexports().createDataExport(
    CreateDataExportRequestBody
        .builder()
        .exportType("company-feature-usage")
        .metadata("metadata")
        .outputFileType("csv")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**exportType:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**metadata:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**outputFileType:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.dataexports.getDataExportArtifact(dataExportId) -> InputStream</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.dataexports().getDataExportArtifact("data_export_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**dataExportId:** `String` — data_export_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## events
<details><summary><code>client.events.createEventBatch(request) -> CreateEventBatchResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.events().createEventBatch(
    CreateEventBatchRequestBody
        .builder()
        .events(
            Arrays.asList(
                CreateEventRequestBody
                    .builder()
                    .eventType(EventType.FLAG_CHECK)
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**events:** `List<CreateEventRequestBody>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.events.getEventSummaries() -> GetEventSummariesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.events().getEventSummaries(
    GetEventSummariesRequest
        .builder()
        .eventSubtypes(
            Arrays.asList("event_subtypes")
        )
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**eventSubtypes:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.events.listEvents() -> ListEventsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.events().listEvents(
    ListEventsRequest
        .builder()
        .eventTypes(
            Arrays.asList(EventType.FLAG_CHECK)
        )
        .companyId("company_id")
        .eventSubtype("event_subtype")
        .flagId("flag_id")
        .idempotencyKey("idempotency_key")
        .userId("user_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**eventSubtype:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**eventTypes:** `Optional<EventType>` 
    
</dd>
</dl>

<dl>
<dd>

**flagId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**idempotencyKey:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**userId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.events.createEvent(request) -> CreateEventResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.events().createEvent(
    CreateEventRequestBody
        .builder()
        .eventType(EventType.FLAG_CHECK)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `CreateEventRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.events.getEvent(eventId) -> GetEventResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.events().getEvent("event_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**eventId:** `String` — event_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.events.getSegmentIntegrationStatus() -> GetSegmentIntegrationStatusResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.events().getSegmentIntegrationStatus();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## features
<details><summary><code>client.features.listFeatures() -> ListFeaturesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().listFeatures(
    ListFeaturesRequest
        .builder()
        .featureType(
            Arrays.asList(FeatureType.BOOLEAN)
        )
        .ids(
            Arrays.asList("ids")
        )
        .booleanRequireEvent(true)
        .managedBy(BillingProviderType.ORB)
        .planVersionId("plan_version_id")
        .q("q")
        .withoutCompanyOverrideFor("without_company_override_for")
        .withoutPlanEntitlementFor("without_plan_entitlement_for")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**booleanRequireEvent:** `Optional<Boolean>` — Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter.
    
</dd>
</dl>

<dl>
<dd>

**featureType:** `Optional<FeatureType>` — Filter by one or more feature types (boolean, event, trait)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**managedBy:** `Optional<BillingProviderType>` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` — Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search by feature name or ID
    
</dd>
</dl>

<dl>
<dd>

**withoutCompanyOverrideFor:** `Optional<String>` — Filter out features that already have a company override for the specified company ID
    
</dd>
</dl>

<dl>
<dd>

**withoutPlanEntitlementFor:** `Optional<String>` — Filter out features that already have a plan entitlement for the specified plan ID
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.createFeature(request) -> CreateFeatureResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().createFeature(
    CreateFeatureRequestBody
        .builder()
        .description("description")
        .featureType(FeatureType.BOOLEAN)
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**description:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**eventSubtype:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**featureType:** `FeatureType` 
    
</dd>
</dl>

<dl>
<dd>

**flag:** `Optional<CreateOrUpdateFlagRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**icon:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**lifecyclePhase:** `Optional<FeatureLifecyclePhase>` 
    
</dd>
</dl>

<dl>
<dd>

**maintainerAccountMemberId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**pluralName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**singularName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitId:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.getFeature(featureId) -> GetFeatureResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().getFeature("feature_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `String` — feature_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.updateFeature(featureId, request) -> UpdateFeatureResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().updateFeature(
    "feature_id",
    UpdateFeatureRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `String` — feature_id
    
</dd>
</dl>

<dl>
<dd>

**description:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**eventSubtype:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**featureType:** `Optional<FeatureType>` 
    
</dd>
</dl>

<dl>
<dd>

**flag:** `Optional<CreateOrUpdateFlagRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**icon:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**lifecyclePhase:** `Optional<FeatureLifecyclePhase>` 
    
</dd>
</dl>

<dl>
<dd>

**maintainerAccountMemberId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**pluralName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**singularName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitId:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.deleteFeature(featureId) -> DeleteFeatureResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().deleteFeature("feature_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `String` — feature_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.upsertFeatureForBillingProduct(request) -> UpsertFeatureForBillingProductResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().upsertFeatureForBillingProduct(
    CreateBillingLinkedFeatureRequestBody
        .builder()
        .billingProvider(BillingProviderType.ORB)
        .description("description")
        .externalResourceId("external_resource_id")
        .featureType(FeatureType.BOOLEAN)
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingProvider:** `BillingProviderType` 
    
</dd>
</dl>

<dl>
<dd>

**description:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**eventSubtype:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**externalResourceId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**featureType:** `FeatureType` 
    
</dd>
</dl>

<dl>
<dd>

**flag:** `Optional<CreateOrUpdateFlagRequestBody>` 
    
</dd>
</dl>

<dl>
<dd>

**icon:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**lifecyclePhase:** `Optional<FeatureLifecyclePhase>` 
    
</dd>
</dl>

<dl>
<dd>

**maintainerAccountMemberId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**pluralName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**singularName:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**traitId:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.countFeatures() -> CountFeaturesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().countFeatures(
    CountFeaturesRequest
        .builder()
        .featureType(
            Arrays.asList(FeatureType.BOOLEAN)
        )
        .ids(
            Arrays.asList("ids")
        )
        .booleanRequireEvent(true)
        .managedBy(BillingProviderType.ORB)
        .planVersionId("plan_version_id")
        .q("q")
        .withoutCompanyOverrideFor("without_company_override_for")
        .withoutPlanEntitlementFor("without_plan_entitlement_for")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**booleanRequireEvent:** `Optional<Boolean>` — Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter.
    
</dd>
</dl>

<dl>
<dd>

**featureType:** `Optional<FeatureType>` — Filter by one or more feature types (boolean, event, trait)
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**managedBy:** `Optional<BillingProviderType>` — Filter for features managed by a billing provider, or by Schematic (no billing provider)
    
</dd>
</dl>

<dl>
<dd>

**planVersionId:** `Optional<String>` — Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search by feature name or ID
    
</dd>
</dl>

<dl>
<dd>

**withoutCompanyOverrideFor:** `Optional<String>` — Filter out features that already have a company override for the specified company ID
    
</dd>
</dl>

<dl>
<dd>

**withoutPlanEntitlementFor:** `Optional<String>` — Filter out features that already have a plan entitlement for the specified plan ID
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.listFlags() -> ListFlagsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().listFlags(
    ListFlagsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .featureId("feature_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search by flag name, key, or ID
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.createFlag(request) -> CreateFlagResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().createFlag(
    CreateFlagRequestBody
        .builder()
        .defaultValue(true)
        .description("description")
        .flagType("boolean")
        .key("key")
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `CreateFlagRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.getFlag(flagId) -> GetFlagResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().getFlag("flag_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**flagId:** `String` — flag_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.updateFlag(flagId, request) -> UpdateFlagResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().updateFlag(
    "flag_id",
    CreateFlagRequestBody
        .builder()
        .defaultValue(true)
        .description("description")
        .flagType("boolean")
        .key("key")
        .name("name")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**flagId:** `String` — flag_id
    
</dd>
</dl>

<dl>
<dd>

**request:** `CreateFlagRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.deleteFlag(flagId) -> DeleteFlagResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().deleteFlag("flag_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**flagId:** `String` — flag_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.updateFlagRules(flagId, request) -> UpdateFlagRulesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().updateFlagRules(
    "flag_id",
    UpdateFlagRulesRequestBody
        .builder()
        .rules(
            Arrays.asList(
                CreateOrUpdateRuleRequestBody
                    .builder()
                    .name("name")
                    .priority(1000000L)
                    .value(true)
                    .conditionGroups(
                        Arrays.asList(
                            CreateOrUpdateConditionGroupRequestBody
                                .builder()
                                .conditions(
                                    Arrays.asList(
                                        CreateOrUpdateConditionRequestBody
                                            .builder()
                                            .conditionType(ConditionType.BASE_PLAN)
                                            .operator(ComparableOperator.EQ)
                                            .resourceIds(
                                                Arrays.asList("resource_ids")
                                            )
                                            .build()
                                    )
                                )
                                .build()
                        )
                    )
                    .conditions(
                        Arrays.asList(
                            CreateOrUpdateConditionRequestBody
                                .builder()
                                .conditionType(ConditionType.BASE_PLAN)
                                .operator(ComparableOperator.EQ)
                                .resourceIds(
                                    Arrays.asList("resource_ids")
                                )
                                .build()
                        )
                    )
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**flagId:** `String` — flag_id
    
</dd>
</dl>

<dl>
<dd>

**rules:** `List<CreateOrUpdateRuleRequestBody>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.checkFlag(key, request) -> CheckFlagResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().checkFlag(
    "key",
    CheckFlagRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**key:** `String` — key
    
</dd>
</dl>

<dl>
<dd>

**request:** `CheckFlagRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.checkFlags(request) -> CheckFlagsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().checkFlags(
    CheckFlagRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**request:** `CheckFlagRequestBody` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.checkFlagsBulk(request) -> CheckFlagsBulkResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().checkFlagsBulk(
    CheckFlagsBulkRequestBody
        .builder()
        .contexts(
            Arrays.asList(
                CheckFlagRequestBody
                    .builder()
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**contexts:** `List<CheckFlagRequestBody>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.features.countFlags() -> CountFlagsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.features().countFlags(
    CountFlagsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .featureId("feature_id")
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**featureId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` — Search by flag name, key, or ID
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## insights
<details><summary><code>client.insights.getActivity() -> GetActivityResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.insights().getActivity(
    GetActivityRequest
        .builder()
        .limit(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**limit:** `Optional<Long>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.insights.getEnvironmentFeatureUsageTimeSeries() -> GetEnvironmentFeatureUsageTimeSeriesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.insights().getEnvironmentFeatureUsageTimeSeries(
    GetEnvironmentFeatureUsageTimeSeriesRequest
        .builder()
        .endTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .featureId("feature_id")
        .startTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .granularity(TimeSeriesGranularity.DAILY)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**endTime:** `OffsetDateTime` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**granularity:** `Optional<TimeSeriesGranularity>` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `OffsetDateTime` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.insights.getPlanGrowth() -> GetPlanGrowthResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.insights().getPlanGrowth(
    GetPlanGrowthRequest
        .builder()
        .months(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**months:** `Optional<Long>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.insights.getSummary() -> GetSummaryResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.insights().getSummary();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.insights.getTopFeaturesByUsage() -> GetTopFeaturesByUsageResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.insights().getTopFeaturesByUsage(
    GetTopFeaturesByUsageRequest
        .builder()
        .endTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .startTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .limit(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**endTime:** `OffsetDateTime` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `OffsetDateTime` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.insights.getEnvironmentTraitUsageTimeSeries() -> GetEnvironmentTraitUsageTimeSeriesResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.insights().getEnvironmentTraitUsageTimeSeries(
    GetEnvironmentTraitUsageTimeSeriesRequest
        .builder()
        .endTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .featureId("feature_id")
        .startTime(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .granularity(TimeSeriesGranularity.DAILY)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**endTime:** `OffsetDateTime` 
    
</dd>
</dl>

<dl>
<dd>

**featureId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**granularity:** `Optional<TimeSeriesGranularity>` 
    
</dd>
</dl>

<dl>
<dd>

**startTime:** `OffsetDateTime` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## integrationsapi
<details><summary><code>client.integrationsapi.runIntegration(integrationId) -> RunIntegrationResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.integrationsapi().runIntegration("integration_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**integrationId:** `String` — integration_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.integrationsapi.listIntegrations() -> ListIntegrationsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.integrationsapi().listIntegrations(
    ListIntegrationsRequest
        .builder()
        .excludeIds(
            Arrays.asList("exclude_ids")
        )
        .billingOnly(true)
        .id("id")
        .state(IntegrationState.ACTIVE)
        .type(IntegrationType.CLERK)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**billingOnly:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**excludeIds:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**id:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**state:** `Optional<IntegrationState>` 
    
</dd>
</dl>

<dl>
<dd>

**type:** `Optional<IntegrationType>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.integrationsapi.getIntegrationWebhookUrl(type) -> GetIntegrationWebhookUrlResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.integrationsapi().getIntegrationWebhookUrl("type");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**type:** `String` — type
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.integrationsapi.startDataImport(request) -> StartDataImportResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.integrationsapi().startDataImport(
    StartDataImportRequestBody
        .builder()
        .integrationId("integration_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyMatchingCriteria:** `Optional<CompanyMatchingCriteria>` 
    
</dd>
</dl>

<dl>
<dd>

**companyMatchingField:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**integrationId:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.integrationsapi.loadSampleDataSetV2() -> LoadSampleDataSetV2Response</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.integrationsapi().loadSampleDataSetV2();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.integrationsapi.uninstallIntegration(integrationId) -> UninstallIntegrationResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.integrationsapi().uninstallIntegration("integration_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**integrationId:** `String` — integration_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## plangroups
<details><summary><code>client.plangroups.getPlanGroup() -> GetPlanGroupResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plangroups().getPlanGroup(
    GetPlanGroupRequest
        .builder()
        .includeCompanyCounts(true)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**includeCompanyCounts:** `Optional<Boolean>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plangroups.createPlanGroup(request) -> CreatePlanGroupResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plangroups().createPlanGroup(
    CreatePlanGroupRequestBody
        .builder()
        .checkoutCollectAddress(true)
        .checkoutCollectEmail(true)
        .checkoutCollectPhone(true)
        .enableTaxCollection(true)
        .preventDowngradesWhenOverLimit(true)
        .preventSelfServiceDowngrade(true)
        .prorationBehavior(ProrationBehavior.CREATE_PRORATIONS)
        .showAsMonthlyPrices(true)
        .showCredits(true)
        .showFeatureDescription(true)
        .showHardLimit(true)
        .showPeriodToggle(true)
        .showZeroPriceAsFree(true)
        .syncCustomerBillingDetails(true)
        .addOnIds(
            Arrays.asList("add_on_ids")
        )
        .orderedAddOns(
            Arrays.asList(
                OrderedPlansInGroup
                    .builder()
                    .planId("plan_id")
                    .build()
            )
        )
        .orderedBundleList(
            Arrays.asList(
                PlanGroupBundleOrder
                    .builder()
                    .bundleId("bundleId")
                    .build()
            )
        )
        .orderedPlans(
            Arrays.asList(
                OrderedPlansInGroup
                    .builder()
                    .planId("plan_id")
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**addOnCompatibilities:** `Optional<List<CompatiblePlans>>` 
    
</dd>
</dl>

<dl>
<dd>

**addOnIds:** `List<String>` — Use OrderedAddOns instead
    
</dd>
</dl>

<dl>
<dd>

**checkoutCollectAddress:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**checkoutCollectEmail:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**checkoutCollectPhone:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**customPlanConfig:** `Optional<CustomPlanConfig>` 
    
</dd>
</dl>

<dl>
<dd>

**customPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**enableTaxCollection:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**fallbackPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**initialPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**initialPlanPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**orderedAddOns:** `List<OrderedPlansInGroup>` 
    
</dd>
</dl>

<dl>
<dd>

**orderedBundleList:** `List<PlanGroupBundleOrder>` 
    
</dd>
</dl>

<dl>
<dd>

**orderedPlans:** `List<OrderedPlansInGroup>` 
    
</dd>
</dl>

<dl>
<dd>

**preventDowngradesWhenOverLimit:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**preventSelfServiceDowngrade:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**preventSelfServiceDowngradeButtonText:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**preventSelfServiceDowngradeUrl:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**prorationBehavior:** `ProrationBehavior` 
    
</dd>
</dl>

<dl>
<dd>

**scheduledDowngradeBehavior:** `Optional<ScheduledDowngradeConfigBehavior>` 
    
</dd>
</dl>

<dl>
<dd>

**scheduledDowngradePreventWhenOverLimit:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**showAsMonthlyPrices:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showCredits:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showFeatureDescription:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showHardLimit:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showPeriodToggle:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showZeroPriceAsFree:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**syncCustomerBillingDetails:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**trialDays:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**trialExpiryPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**trialExpiryPlanPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**trialPaymentMethodRequired:** `Optional<Boolean>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.plangroups.updatePlanGroup(planGroupId, request) -> UpdatePlanGroupResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.plangroups().updatePlanGroup(
    "plan_group_id",
    UpdatePlanGroupRequestBody
        .builder()
        .checkoutCollectAddress(true)
        .checkoutCollectEmail(true)
        .checkoutCollectPhone(true)
        .enableTaxCollection(true)
        .preventDowngradesWhenOverLimit(true)
        .preventSelfServiceDowngrade(true)
        .prorationBehavior(ProrationBehavior.CREATE_PRORATIONS)
        .showAsMonthlyPrices(true)
        .showCredits(true)
        .showFeatureDescription(true)
        .showHardLimit(true)
        .showPeriodToggle(true)
        .showZeroPriceAsFree(true)
        .syncCustomerBillingDetails(true)
        .addOnIds(
            Arrays.asList("add_on_ids")
        )
        .orderedAddOns(
            Arrays.asList(
                OrderedPlansInGroup
                    .builder()
                    .planId("plan_id")
                    .build()
            )
        )
        .orderedBundleList(
            Arrays.asList(
                PlanGroupBundleOrder
                    .builder()
                    .bundleId("bundleId")
                    .build()
            )
        )
        .orderedPlans(
            Arrays.asList(
                OrderedPlansInGroup
                    .builder()
                    .planId("plan_id")
                    .build()
            )
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planGroupId:** `String` — plan_group_id
    
</dd>
</dl>

<dl>
<dd>

**addOnCompatibilities:** `Optional<List<CompatiblePlans>>` 
    
</dd>
</dl>

<dl>
<dd>

**addOnIds:** `List<String>` — Use OrderedAddOns instead
    
</dd>
</dl>

<dl>
<dd>

**checkoutCollectAddress:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**checkoutCollectEmail:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**checkoutCollectPhone:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**customPlanConfig:** `Optional<CustomPlanConfig>` 
    
</dd>
</dl>

<dl>
<dd>

**customPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**enableTaxCollection:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**fallbackPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**initialPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**initialPlanPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**orderedAddOns:** `List<OrderedPlansInGroup>` 
    
</dd>
</dl>

<dl>
<dd>

**orderedBundleList:** `List<PlanGroupBundleOrder>` 
    
</dd>
</dl>

<dl>
<dd>

**orderedPlans:** `List<OrderedPlansInGroup>` 
    
</dd>
</dl>

<dl>
<dd>

**preventDowngradesWhenOverLimit:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**preventSelfServiceDowngrade:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**preventSelfServiceDowngradeButtonText:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**preventSelfServiceDowngradeUrl:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**prorationBehavior:** `ProrationBehavior` 
    
</dd>
</dl>

<dl>
<dd>

**scheduledDowngradeBehavior:** `Optional<ScheduledDowngradeConfigBehavior>` 
    
</dd>
</dl>

<dl>
<dd>

**scheduledDowngradePreventWhenOverLimit:** `Optional<Boolean>` 
    
</dd>
</dl>

<dl>
<dd>

**showAsMonthlyPrices:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showCredits:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showFeatureDescription:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showHardLimit:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showPeriodToggle:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**showZeroPriceAsFree:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**syncCustomerBillingDetails:** `Boolean` 
    
</dd>
</dl>

<dl>
<dd>

**trialDays:** `Optional<Long>` 
    
</dd>
</dl>

<dl>
<dd>

**trialExpiryPlanId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**trialExpiryPlanPriceId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**trialPaymentMethodRequired:** `Optional<Boolean>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## planmigrations
<details><summary><code>client.planmigrations.listCompanyMigrations() -> ListCompanyMigrationsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planmigrations().listCompanyMigrations(
    ListCompanyMigrationsRequest
        .builder()
        .migrationId("migration_id")
        .q("q")
        .status(PlanVersionCompanyMigrationStatus.COMPLETED)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**migrationId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<PlanVersionCompanyMigrationStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.retryCompanyMigration(planVersionCompanyMigrationId) -> RetryCompanyMigrationResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planmigrations().retryCompanyMigration("plan_version_company_migration_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planVersionCompanyMigrationId:** `String` — plan_version_company_migration_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.countCompanyMigrations() -> CountCompanyMigrationsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planmigrations().countCompanyMigrations(
    CountCompanyMigrationsRequest
        .builder()
        .migrationId("migration_id")
        .q("q")
        .status(PlanVersionCompanyMigrationStatus.COMPLETED)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**migrationId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<PlanVersionCompanyMigrationStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.listMigrations() -> ListMigrationsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planmigrations().listMigrations(
    ListMigrationsRequest
        .builder()
        .planVersionId("plan_version_id")
        .status(PlanVersionMigrationStatus.COMPLETED)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planVersionId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<PlanVersionMigrationStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.createMigration(request) -> CreateMigrationResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planmigrations().createMigration(
    CreateMigrationInput
        .builder()
        .planId("plan_id")
        .planVersionIdTo("plan_version_id_to")
        .strategy(PlanVersionMigrationStrategy.IMMEDIATE)
        .targetPlanType(PlanType.PLAN)
        .companyIds(
            Arrays.asList("company_ids")
        )
        .excludedCompanyIds(
            Arrays.asList("excluded_company_ids")
        )
        .planVersionIdsFrom(
            Arrays.asList("plan_version_ids_from")
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyIds:** `List<String>` 
    
</dd>
</dl>

<dl>
<dd>

**excludedCompanyIds:** `List<String>` 
    
</dd>
</dl>

<dl>
<dd>

**planId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionIdTo:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**planVersionIdsFrom:** `List<String>` 
    
</dd>
</dl>

<dl>
<dd>

**strategy:** `PlanVersionMigrationStrategy` 
    
</dd>
</dl>

<dl>
<dd>

**targetPlanType:** `PlanType` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.getMigration(planVersionMigrationId) -> GetMigrationResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planmigrations().getMigration("plan_version_migration_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planVersionMigrationId:** `String` — plan_version_migration_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.retryMigration(planVersionMigrationId, request) -> RetryMigrationResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planmigrations().retryMigration(
    "plan_version_migration_id",
    RetryMigrationRequestBody
        .builder()
        .errorCodes(
            Arrays.asList(MigrationErrorCode.AMBIGUOUS_SUBSCRIPTION_ITEM)
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planVersionMigrationId:** `String` — plan_version_migration_id
    
</dd>
</dl>

<dl>
<dd>

**errorCodes:** `List<MigrationErrorCode>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.planmigrations.countMigrations() -> CountMigrationsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.planmigrations().countMigrations(
    CountMigrationsRequest
        .builder()
        .planVersionId("plan_version_id")
        .status(PlanVersionMigrationStatus.COMPLETED)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**planVersionId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<PlanVersionMigrationStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## componentspublic
<details><summary><code>client.componentspublic.getPublicPlans() -> GetPublicPlansResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.componentspublic().getPublicPlans();
```
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## scheduledcheckout
<details><summary><code>client.scheduledcheckout.listScheduledCheckouts() -> ListScheduledCheckoutsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.scheduledcheckout().listScheduledCheckouts(
    ListScheduledCheckoutsRequest
        .builder()
        .companyId("company_id")
        .status(ScheduledCheckoutStatus.CANCELLED)
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<ScheduledCheckoutStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.scheduledcheckout.createScheduledCheckout(request) -> CreateScheduledCheckoutResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.scheduledcheckout().createScheduledCheckout(
    CreateScheduledCheckoutRequest
        .builder()
        .companyId("company_id")
        .executeAfter(OffsetDateTime.parse("2024-01-15T09:30:00Z"))
        .fromPlanId("from_plan_id")
        .toPlanId("to_plan_id")
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**companyId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**executeAfter:** `OffsetDateTime` 
    
</dd>
</dl>

<dl>
<dd>

**fromPlanId:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**toPlanId:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.scheduledcheckout.getScheduledCheckout(scheduledCheckoutId) -> GetScheduledCheckoutResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.scheduledcheckout().getScheduledCheckout("scheduled_checkout_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**scheduledCheckoutId:** `String` — scheduled_checkout_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.scheduledcheckout.updateScheduledCheckout(scheduledCheckoutId, request) -> UpdateScheduledCheckoutResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.scheduledcheckout().updateScheduledCheckout(
    "scheduled_checkout_id",
    UpdateScheduledCheckoutRequest
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**scheduledCheckoutId:** `String` — scheduled_checkout_id
    
</dd>
</dl>

<dl>
<dd>

**executeAfter:** `Optional<OffsetDateTime>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<ScheduledCheckoutStatus>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## accesstokens
<details><summary><code>client.accesstokens.issueTemporaryAccessToken(request) -> IssueTemporaryAccessTokenResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.accesstokens().issueTemporaryAccessToken(
    IssueTemporaryAccessTokenRequestBody
        .builder()
        .resourceType("company")
        .lookup(
            new HashMap<String, String>() {{
                put("key", "value");
            }}
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**lookup:** `Map<String, String>` 
    
</dd>
</dl>

<dl>
<dd>

**resourceType:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

## webhooks
<details><summary><code>client.webhooks.listWebhookEvents() -> ListWebhookEventsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().listWebhookEvents(
    ListWebhookEventsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .q("q")
        .webhookId("webhook_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**webhookId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.getWebhookEvent(webhookEventId) -> GetWebhookEventResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().getWebhookEvent("webhook_event_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**webhookEventId:** `String` — webhook_event_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.countWebhookEvents() -> CountWebhookEventsResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().countWebhookEvents(
    CountWebhookEventsRequest
        .builder()
        .ids(
            Arrays.asList("ids")
        )
        .q("q")
        .webhookId("webhook_id")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**ids:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**webhookId:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.listWebhooks() -> ListWebhooksResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().listWebhooks(
    ListWebhooksRequest
        .builder()
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.createWebhook(request) -> CreateWebhookResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().createWebhook(
    CreateWebhookRequestBody
        .builder()
        .name("name")
        .url("url")
        .requestTypes(
            Arrays.asList(WebhookRequestType.SUBSCRIPTION_TRIAL_ENDED)
        )
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**creditTriggerConfigs:** `Optional<List<CreditTriggerConfig>>` 
    
</dd>
</dl>

<dl>
<dd>

**entitlementTriggerConfigs:** `Optional<List<EntitlementTriggerConfig>>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `String` 
    
</dd>
</dl>

<dl>
<dd>

**requestTypes:** `List<WebhookRequestType>` 
    
</dd>
</dl>

<dl>
<dd>

**url:** `String` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.getWebhook(webhookId) -> GetWebhookResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().getWebhook("webhook_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**webhookId:** `String` — webhook_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.updateWebhook(webhookId, request) -> UpdateWebhookResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().updateWebhook(
    "webhook_id",
    UpdateWebhookRequestBody
        .builder()
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**webhookId:** `String` — webhook_id
    
</dd>
</dl>

<dl>
<dd>

**creditTriggerConfigs:** `Optional<List<CreditTriggerConfig>>` 
    
</dd>
</dl>

<dl>
<dd>

**entitlementTriggerConfigs:** `Optional<List<EntitlementTriggerConfig>>` 
    
</dd>
</dl>

<dl>
<dd>

**name:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**requestTypes:** `Optional<List<WebhookRequestType>>` 
    
</dd>
</dl>

<dl>
<dd>

**status:** `Optional<WebhookStatus>` 
    
</dd>
</dl>

<dl>
<dd>

**url:** `Optional<String>` 
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.deleteWebhook(webhookId) -> DeleteWebhookResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().deleteWebhook("webhook_id");
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**webhookId:** `String` — webhook_id
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.webhooks.countWebhooks() -> CountWebhooksResponse</code></summary>
<dl>
<dd>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```java
client.webhooks().countWebhooks(
    CountWebhooksRequest
        .builder()
        .q("q")
        .limit(1000000L)
        .offset(1000000L)
        .build()
);
```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**q:** `Optional<String>` 
    
</dd>
</dl>

<dl>
<dd>

**limit:** `Optional<Long>` — Page limit (default 100)
    
</dd>
</dl>

<dl>
<dd>

**offset:** `Optional<Long>` — Page offset (default 0)
    
</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>