client.putPlanAudiencesPlanAudienceId(planAudienceId)
-
-
-
client.putPlanAudiencesPlanAudienceId("plan_audience_id");
-
-
-
planAudienceId:
String
-
-
client.deletePlanAudiencesPlanAudienceId(planAudienceId)
-
-
-
client.deletePlanAudiencesPlanAudienceId("plan_audience_id");
-
-
-
planAudienceId:
String
-
-
client.accounts.listApiKeys() -> ListApiKeysResponse
-
-
-
client.accounts().listApiKeys( ListApiKeysRequest .builder() .requireEnvironment(true) .environmentId("environment_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
environmentId:
Optional<String>
-
requireEnvironment:
Boolean
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.accounts.createApiKey(request) -> CreateApiKeyResponse
-
-
-
client.accounts().createApiKey( CreateApiKeyRequestBody .builder() .name("name") .build() );
-
-
-
description:
Optional<String>
-
environmentId:
Optional<String>
-
name:
String
-
readonly:
Optional<Boolean>
-
-
client.accounts.getApiKey(apiKeyId) -> GetApiKeyResponse
-
-
-
client.accounts().getApiKey("api_key_id");
-
-
-
apiKeyId:
String— api_key_id
-
-
client.accounts.updateApiKey(apiKeyId, request) -> UpdateApiKeyResponse
-
-
-
client.accounts().updateApiKey( "api_key_id", UpdateApiKeyRequestBody .builder() .build() );
-
-
-
apiKeyId:
String— api_key_id
-
description:
Optional<String>
-
name:
Optional<String>
-
-
client.accounts.deleteApiKey(apiKeyId) -> DeleteApiKeyResponse
-
-
-
client.accounts().deleteApiKey("api_key_id");
-
-
-
apiKeyId:
String— api_key_id
-
-
client.accounts.countApiKeys() -> CountApiKeysResponse
-
-
-
client.accounts().countApiKeys( CountApiKeysRequest .builder() .requireEnvironment(true) .environmentId("environment_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
environmentId:
Optional<String>
-
requireEnvironment:
Boolean
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.accounts.listAuditLogs() -> ListAuditLogsResponse
-
-
-
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() );
-
-
-
actorType:
Optional<ActorType>
-
endTime:
Optional<OffsetDateTime>
-
environmentId:
Optional<String>
-
q:
Optional<String>
-
startTime:
Optional<OffsetDateTime>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.accounts.getAuditLog(auditLogId) -> GetAuditLogResponse
-
-
-
client.accounts().getAuditLog("audit_log_id");
-
-
-
auditLogId:
String— audit_log_id
-
-
client.accounts.countAuditLogs() -> CountAuditLogsResponse
-
-
-
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() );
-
-
-
actorType:
Optional<ActorType>
-
endTime:
Optional<OffsetDateTime>
-
environmentId:
Optional<String>
-
q:
Optional<String>
-
startTime:
Optional<OffsetDateTime>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.accounts.listEnvironments() -> ListEnvironmentsResponse
-
-
-
client.accounts().listEnvironments( ListEnvironmentsRequest .builder() .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.accounts.createEnvironment(request) -> CreateEnvironmentResponse
-
-
-
client.accounts().createEnvironment( CreateEnvironmentRequestBody .builder() .environmentType(EnvironmentType.DEVELOPMENT) .name("name") .build() );
-
-
-
environmentType:
EnvironmentType
-
name:
String
-
-
client.accounts.getEnvironment(environmentId) -> GetEnvironmentResponse
-
-
-
client.accounts().getEnvironment("environment_id");
-
-
-
environmentId:
String— environment_id
-
-
client.accounts.updateEnvironment(environmentId, request) -> UpdateEnvironmentResponse
-
-
-
client.accounts().updateEnvironment( "environment_id", UpdateEnvironmentRequestBody .builder() .build() );
-
-
-
environmentId:
String— environment_id
-
environmentType:
Optional<EnvironmentType>
-
name:
Optional<String>
-
-
client.accounts.deleteEnvironment(environmentId) -> DeleteEnvironmentResponse
-
-
-
client.accounts().deleteEnvironment("environment_id");
-
-
-
environmentId:
String— environment_id
-
-
client.billing.listCoupons() -> ListCouponsResponse
-
-
-
client.billing().listCoupons( ListCouponsRequest .builder() .isActive(true) .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
isActive:
Optional<Boolean>
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.upsertBillingCoupon(request) -> UpsertBillingCouponResponse
-
-
-
client.billing().upsertBillingCoupon( CreateCouponRequestBody .builder() .amountOff(1000000L) .duration("duration") .durationInMonths(1000000L) .externalId("external_id") .maxRedemptions(1000000L) .name("name") .percentOff(1.1) .timesRedeemed(1000000L) .build() );
-
-
-
amountOff:
Long
-
currency:
Optional<String>
-
duration:
String
-
durationInMonths:
Long
-
externalId:
String
-
maxRedemptions:
Long
-
name:
String
-
percentOff:
Double
-
timesRedeemed:
Long
-
-
client.billing.upsertBillingCustomer(request) -> UpsertBillingCustomerResponse
-
-
-
client.billing().upsertBillingCustomer( CreateBillingCustomerRequestBody .builder() .email("email") .externalId("external_id") .name("name") .meta( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
companyId:
Optional<String>
-
defaultPaymentMethodId:
Optional<String>
-
email:
String
-
externalId:
String
-
meta:
Map<String, String>
-
name:
String
-
providerType:
Optional<BillingProviderType>
-
-
client.billing.listCustomersWithSubscriptions() -> ListCustomersWithSubscriptionsResponse
-
-
-
client.billing().listCustomersWithSubscriptions( ListCustomersWithSubscriptionsRequest .builder() .name("name") .providerType(BillingProviderType.SCHEMATIC) .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyIds:
Optional<String>
-
name:
Optional<String>
-
providerType:
Optional<BillingProviderType>
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.countCustomers() -> CountCustomersResponse
-
-
-
client.billing().countCustomers( CountCustomersRequest .builder() .name("name") .providerType(BillingProviderType.SCHEMATIC) .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyIds:
Optional<String>
-
name:
Optional<String>
-
providerType:
Optional<BillingProviderType>
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.listInvoices() -> ListInvoicesResponse
-
-
-
client.billing().listInvoices( ListInvoicesRequest .builder() .customerExternalId("customer_external_id") .subscriptionExternalId("subscription_external_id") .companyId("company_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
customerExternalId:
String
-
subscriptionExternalId:
String
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.upsertInvoice(request) -> UpsertInvoiceResponse
-
-
-
client.billing().upsertInvoice( CreateInvoiceRequestBody .builder() .amountDue(1000000L) .amountPaid(1000000L) .amountRemaining(1000000L) .collectionMethod("collection_method") .currency("currency") .customerExternalId("customer_external_id") .subtotal(1000000L) .build() );
-
-
-
amountDue:
Long
-
amountPaid:
Long
-
amountRemaining:
Long
-
collectionMethod:
String
-
currency:
String
-
customerExternalId:
String
-
dueDate:
Optional<OffsetDateTime>
-
externalId:
Optional<String>
-
paymentMethodExternalId:
Optional<String>
-
status:
Optional<InvoiceStatus>
-
subscriptionExternalId:
Optional<String>
-
subtotal:
Long
-
url:
Optional<String>
-
-
client.billing.listMeters() -> ListMetersResponse
-
-
-
client.billing().listMeters( ListMetersRequest .builder() .displayName("display_name") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
displayName:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.upsertBillingMeter(request) -> UpsertBillingMeterResponse
-
-
-
client.billing().upsertBillingMeter( CreateMeterRequestBody .builder() .displayName("display_name") .eventName("event_name") .eventPayloadKey("event_payload_key") .externalId("external_id") .build() );
-
-
-
displayName:
String
-
eventName:
String
-
eventPayloadKey:
String
-
externalId:
String
-
-
client.billing.listPaymentMethods() -> ListPaymentMethodsResponse
-
-
-
client.billing().listPaymentMethods( ListPaymentMethodsRequest .builder() .customerExternalId("customer_external_id") .companyId("company_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
customerExternalId:
String
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.upsertPaymentMethod(request) -> UpsertPaymentMethodResponse
-
-
-
client.billing().upsertPaymentMethod( CreatePaymentMethodRequestBody .builder() .customerExternalId("customer_external_id") .externalId("external_id") .paymentMethodType("payment_method_type") .build() );
-
-
-
accountLast4:
Optional<String>
-
accountName:
Optional<String>
-
bankName:
Optional<String>
-
billingEmail:
Optional<String>
-
billingName:
Optional<String>
-
cardBrand:
Optional<String>
-
cardExpMonth:
Optional<Long>
-
cardExpYear:
Optional<Long>
-
cardLast4:
Optional<String>
-
customerExternalId:
String
-
externalId:
String
-
paymentMethodType:
String
-
-
client.billing.listBillingPrices() -> ListBillingPricesResponse
-
-
-
client.billing().listBillingPrices( ListBillingPricesRequest .builder() .currency("currency") .forInitialPlan(true) .forTrialExpiryPlan(true) .interval("interval") .isActive(true) .price(1000000L) .productId("product_id") .providerType(BillingProviderType.SCHEMATIC) .q("q") .tiersMode(BillingTiersMode.GRADUATED) .usageType(BillingPriceUsageType.LICENSED) .withMeter(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
currency:
Optional<String>— Filter for prices in a specific currency (e.g. usd, eur)
-
forInitialPlan:
Optional<Boolean>— Filter for prices valid for initial plans (free prices only)
-
forTrialExpiryPlan:
Optional<Boolean>— Filter for prices valid for trial expiry plans (free prices only)
-
ids:
Optional<String>
-
interval:
Optional<String>
-
isActive:
Optional<Boolean>— Filter for active prices on active products (defaults to true if not specified)
-
price:
Optional<Long>
-
productId:
Optional<String>
-
productIds:
Optional<String>
-
providerType:
Optional<BillingProviderType>
-
q:
Optional<String>
-
tiersMode:
Optional<BillingTiersMode>
-
usageType:
Optional<BillingPriceUsageType>
-
withMeter:
Optional<Boolean>— Filter for prices with a meter
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.upsertBillingPrice(request) -> UpsertBillingPriceResponse
-
-
-
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() );
-
-
-
billingScheme:
BillingPriceScheme
-
currency:
String
-
externalAccountId:
String
-
interval:
String
-
isActive:
Boolean
-
meterId:
Optional<String>
-
packageSize:
Optional<Long>
-
price:
Long
-
priceDecimal:
Optional<String>
-
priceExternalId:
String
-
priceTiers:
List<CreateBillingPriceTierRequestBody>
-
productExternalId:
String
-
providerType:
Optional<BillingProviderType>
-
tiersMode:
Optional<BillingTiersMode>
-
usageType:
BillingPriceUsageType
-
-
client.billing.deleteBillingProduct(billingId) -> DeleteBillingProductResponse
-
-
-
client.billing().deleteBillingProduct("billing_id");
-
-
-
billingId:
String— billing_id
-
-
client.billing.listBillingProductPrices() -> ListBillingProductPricesResponse
-
-
-
client.billing().listBillingProductPrices( ListBillingProductPricesRequest .builder() .currency("currency") .forInitialPlan(true) .forTrialExpiryPlan(true) .interval("interval") .isActive(true) .price(1000000L) .productId("product_id") .providerType(BillingProviderType.SCHEMATIC) .q("q") .tiersMode(BillingTiersMode.GRADUATED) .usageType(BillingPriceUsageType.LICENSED) .withMeter(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
currency:
Optional<String>— Filter for prices in a specific currency (e.g. usd, eur)
-
forInitialPlan:
Optional<Boolean>— Filter for prices valid for initial plans (free prices only)
-
forTrialExpiryPlan:
Optional<Boolean>— Filter for prices valid for trial expiry plans (free prices only)
-
ids:
Optional<String>
-
interval:
Optional<String>
-
isActive:
Optional<Boolean>— Filter for active prices on active products (defaults to true if not specified)
-
price:
Optional<Long>
-
productId:
Optional<String>
-
productIds:
Optional<String>
-
providerType:
Optional<BillingProviderType>
-
q:
Optional<String>
-
tiersMode:
Optional<BillingTiersMode>
-
usageType:
Optional<BillingPriceUsageType>
-
withMeter:
Optional<Boolean>— Filter for prices with a meter
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.deleteProductPrice(billingId) -> DeleteProductPriceResponse
-
-
-
client.billing().deleteProductPrice("billing_id");
-
-
-
billingId:
String— billing_id
-
-
client.billing.upsertBillingProduct(request) -> UpsertBillingProductResponse
-
-
-
client.billing().upsertBillingProduct( CreateBillingProductRequestBody .builder() .externalId("external_id") .price(1.1) .build() );
-
-
-
externalId:
String
-
isActive:
Optional<Boolean>
-
name:
Optional<String>
-
price:
Double
-
providerType:
Optional<BillingProviderType>
-
-
client.billing.listBillingProducts() -> ListBillingProductsResponse
-
-
-
client.billing().listBillingProducts( ListBillingProductsRequest .builder() .isActive(true) .name("name") .priceUsageType(BillingPriceUsageType.LICENSED) .providerType(BillingProviderType.SCHEMATIC) .q("q") .withOneTimeCharges(true) .withPricesOnly(true) .withZeroPrice(true) .withoutLinkedToPlan(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
isActive:
Optional<Boolean>— Filter products that are active. Defaults to true if not specified
-
name:
Optional<String>
-
priceUsageType:
Optional<BillingPriceUsageType>
-
providerType:
Optional<BillingProviderType>
-
q:
Optional<String>
-
withOneTimeCharges:
Optional<Boolean>— Filter products that are one time charges
-
withPricesOnly:
Optional<Boolean>— Filter products that have prices
-
withZeroPrice:
Optional<Boolean>— Filter products that have zero price for free subscription type
-
withoutLinkedToPlan:
Optional<Boolean>— Filter products that are not linked to any plan
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.countBillingProducts() -> CountBillingProductsResponse
-
-
-
client.billing().countBillingProducts( CountBillingProductsRequest .builder() .isActive(true) .name("name") .priceUsageType(BillingPriceUsageType.LICENSED) .providerType(BillingProviderType.SCHEMATIC) .q("q") .withOneTimeCharges(true) .withPricesOnly(true) .withZeroPrice(true) .withoutLinkedToPlan(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
isActive:
Optional<Boolean>— Filter products that are active. Defaults to true if not specified
-
name:
Optional<String>
-
priceUsageType:
Optional<BillingPriceUsageType>
-
providerType:
Optional<BillingProviderType>
-
q:
Optional<String>
-
withOneTimeCharges:
Optional<Boolean>— Filter products that are one time charges
-
withPricesOnly:
Optional<Boolean>— Filter products that have prices
-
withZeroPrice:
Optional<Boolean>— Filter products that have zero price for free subscription type
-
withoutLinkedToPlan:
Optional<Boolean>— Filter products that are not linked to any plan
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.billing.upsertBillingSubscription(request) -> UpsertBillingSubscriptionResponse
-
-
-
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() );
-
-
-
applicationId:
Optional<String>
-
cancelAt:
Optional<Long>
-
cancelAtPeriodEnd:
Boolean
-
currency:
String
-
customerExternalId:
String
-
defaultPaymentMethodExternalId:
Optional<String>
-
defaultPaymentMethodId:
Optional<String>
-
discounts:
List<BillingSubscriptionDiscount>
-
expiredAt:
OffsetDateTime
-
interval:
Optional<String>
-
metadata:
Optional<Map<String, Object>>
-
periodEnd:
Optional<Long>
-
periodStart:
Optional<Long>
-
productExternalIds:
List<BillingProductPricing>
-
status:
Optional<String>
-
subscriptionExternalId:
String
-
totalPrice:
Long
-
trialEnd:
Optional<Long>
-
trialEndSetting:
Optional<BillingSubscriptionTrialEndSetting>
-
-
client.credits.listBillingCredits() -> ListBillingCreditsResponse
-
-
-
client.credits().listBillingCredits( ListBillingCreditsRequest .builder() .name("name") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
name:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.createBillingCredit(request) -> CreateBillingCreditResponse
-
-
-
client.credits().createBillingCredit( CreateBillingCreditRequestBody .builder() .currency("currency") .description("description") .name("name") .build() );
-
-
-
burnStrategy:
Optional<BillingCreditBurnStrategy>
-
currency:
String
-
currencyPrices:
Optional<List<CreditCurrencyPriceRequestBody>>
-
defaultExpiryUnit:
Optional<BillingCreditExpiryUnit>
-
defaultExpiryUnitCount:
Optional<Long>
-
defaultRolloverPolicy:
Optional<BillingCreditRolloverPolicy>
-
description:
String
-
icon:
Optional<String>
-
name:
String
-
perUnitPrice:
Optional<Long>
-
perUnitPriceDecimal:
Optional<String>
-
pluralName:
Optional<String>
-
singularName:
Optional<String>
-
-
client.credits.getSingleBillingCredit(creditId) -> GetSingleBillingCreditResponse
-
-
-
client.credits().getSingleBillingCredit("credit_id");
-
-
-
creditId:
String— credit_id
-
-
client.credits.updateBillingCredit(creditId, request) -> UpdateBillingCreditResponse
-
-
-
client.credits().updateBillingCredit( "credit_id", UpdateBillingCreditRequestBody .builder() .description("description") .name("name") .build() );
-
-
-
creditId:
String— credit_id
-
burnStrategy:
Optional<BillingCreditBurnStrategy>
-
currencyPrices:
Optional<List<CreditCurrencyPriceRequestBody>>
-
defaultExpiryUnit:
Optional<BillingCreditExpiryUnit>
-
defaultExpiryUnitCount:
Optional<Long>
-
defaultRolloverPolicy:
Optional<BillingCreditRolloverPolicy>
-
description:
String
-
icon:
Optional<String>
-
name:
String
-
perUnitPrice:
Optional<Long>
-
perUnitPriceDecimal:
Optional<String>
-
pluralName:
Optional<String>
-
singularName:
Optional<String>
-
-
client.credits.softDeleteBillingCredit(creditId) -> SoftDeleteBillingCreditResponse
-
-
-
client.credits().softDeleteBillingCredit("credit_id");
-
-
-
creditId:
String— credit_id
-
-
client.credits.listCreditBundles() -> ListCreditBundlesResponse
-
-
-
client.credits().listCreditBundles( ListCreditBundlesRequest .builder() .creditId("credit_id") .status(BillingCreditBundleStatus.ACTIVE) .bundleType("fixed") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
creditId:
Optional<String>
-
status:
Optional<BillingCreditBundleStatus>
-
bundleType:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.createCreditBundle(request) -> CreateCreditBundleResponse
-
-
-
client.credits().createCreditBundle( CreateCreditBundleRequestBody .builder() .bundleName("bundle_name") .creditId("credit_id") .currency("currency") .pricePerUnit(1000000L) .build() );
-
-
-
bundleName:
String
-
bundleType:
Optional<String>
-
creditId:
String
-
currency:
String
-
currencyPrices:
Optional<List<CreditBundleCurrencyPriceRequestBody>>
-
expiryType:
Optional<BillingCreditExpiryType>
-
expiryUnit:
Optional<BillingCreditExpiryUnit>
-
expiryUnitCount:
Optional<Long>
-
pricePerUnit:
Long
-
pricePerUnitDecimal:
Optional<String>
-
quantity:
Optional<Long>
-
status:
Optional<BillingCreditBundleStatus>
-
-
client.credits.getCreditBundle(bundleId) -> GetCreditBundleResponse
-
-
-
client.credits().getCreditBundle("bundle_id");
-
-
-
bundleId:
String— bundle_id
-
-
client.credits.updateCreditBundleDetails(bundleId, request) -> UpdateCreditBundleDetailsResponse
-
-
-
client.credits().updateCreditBundleDetails( "bundle_id", UpdateCreditBundleDetailsRequestBody .builder() .bundleName("bundle_name") .pricePerUnit(1000000L) .build() );
-
-
-
bundleId:
String— bundle_id
-
bundleName:
String
-
currencyPrices:
Optional<List<CreditBundleCurrencyPriceRequestBody>>
-
expiryType:
Optional<BillingCreditExpiryType>
-
expiryUnit:
Optional<BillingCreditExpiryUnit>
-
expiryUnitCount:
Optional<Long>
-
pricePerUnit:
Long
-
pricePerUnitDecimal:
Optional<String>
-
quantity:
Optional<Long>
-
status:
Optional<BillingCreditBundleStatus>
-
-
client.credits.deleteCreditBundle(bundleId) -> DeleteCreditBundleResponse
-
-
-
client.credits().deleteCreditBundle("bundle_id");
-
-
-
bundleId:
String— bundle_id
-
-
client.credits.countCreditBundles() -> CountCreditBundlesResponse
-
-
-
client.credits().countCreditBundles( CountCreditBundlesRequest .builder() .creditId("credit_id") .status(BillingCreditBundleStatus.ACTIVE) .bundleType("fixed") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
creditId:
Optional<String>
-
status:
Optional<BillingCreditBundleStatus>
-
bundleType:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.countBillingCredits() -> CountBillingCreditsResponse
-
-
-
client.credits().countBillingCredits( CountBillingCreditsRequest .builder() .name("name") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
name:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.zeroOutGrant(grantId, request) -> ZeroOutGrantResponse
-
-
-
client.credits().zeroOutGrant( "grant_id", ZeroOutGrantRequestBody .builder() .build() );
-
-
-
grantId:
String— grant_id
-
reason:
Optional<BillingCreditGrantZeroedOutReason>
-
-
client.credits.grantBillingCreditsToCompany(request) -> GrantBillingCreditsToCompanyResponse
-
-
-
client.credits().grantBillingCreditsToCompany( CreateCompanyCreditGrant .builder() .companyId("company_id") .creditId("credit_id") .quantity(1000000L) .reason(BillingCreditGrantReason.BILLING_CREDIT_AUTO_TOPUP) .build() );
-
-
-
billingPeriodsCount:
Optional<Long>
-
companyId:
String
-
creditId:
String
-
currency:
Optional<String>
-
expiresAt:
Optional<OffsetDateTime>
-
expiryType:
Optional<BillingCreditExpiryType>
-
expiryUnit:
Optional<BillingCreditExpiryUnit>
-
expiryUnitCount:
Optional<Long>
-
quantity:
Long
-
reason:
BillingCreditGrantReason
-
renewalEnabled:
Optional<Boolean>
-
renewalPeriod:
Optional<BillingPlanCreditGrantResetStart>
-
-
client.credits.countCompanyGrants() -> CountCompanyGrantsResponse
-
-
-
client.credits().countCompanyGrants( CountCompanyGrantsRequest .builder() .companyId("company_id") .order(CreditGrantSortOrder.CREATED_AT) .dir(SortDirection.ASC) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
order:
Optional<CreditGrantSortOrder>
-
dir:
Optional<SortDirection>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.listCompanyGrants() -> ListCompanyGrantsResponse
-
-
-
client.credits().listCompanyGrants( ListCompanyGrantsRequest .builder() .companyId("company_id") .order(CreditGrantSortOrder.CREATED_AT) .dir(SortDirection.ASC) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
order:
Optional<CreditGrantSortOrder>
-
dir:
Optional<SortDirection>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.countBillingCreditsGrants() -> CountBillingCreditsGrantsResponse
-
-
-
client.credits().countBillingCreditsGrants( CountBillingCreditsGrantsRequest .builder() .creditId("credit_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
creditId:
Optional<String>
-
ids:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.listGrantsForCredit() -> ListGrantsForCreditResponse
-
-
-
client.credits().listGrantsForCredit( ListGrantsForCreditRequest .builder() .creditId("credit_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
creditId:
Optional<String>
-
ids:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.getEnrichedCreditLedger() -> GetEnrichedCreditLedgerResponse
-
-
-
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() );
-
-
-
companyId:
String
-
billingCreditId:
Optional<String>
-
featureId:
Optional<String>
-
period:
CreditLedgerPeriod
-
startTime:
Optional<String>
-
endTime:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.countCreditLedger() -> CountCreditLedgerResponse
-
-
-
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() );
-
-
-
companyId:
String
-
billingCreditId:
Optional<String>
-
featureId:
Optional<String>
-
period:
CreditLedgerPeriod
-
startTime:
Optional<String>
-
endTime:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.listBillingPlanCreditGrants() -> ListBillingPlanCreditGrantsResponse
-
-
-
client.credits().listBillingPlanCreditGrants( ListBillingPlanCreditGrantsRequest .builder() .creditId("credit_id") .planId("plan_id") .planVersionId("plan_version_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
creditId:
Optional<String>
-
ids:
Optional<String>
-
planId:
Optional<String>
-
planIds:
Optional<String>
-
planVersionId:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.createBillingPlanCreditGrant(request) -> CreateBillingPlanCreditGrantResponse
-
-
-
client.credits().createBillingPlanCreditGrant( CreateBillingPlanCreditGrantRequestBody .builder() .creditAmount(1000000L) .creditId("credit_id") .planId("plan_id") .resetCadence(BillingPlanCreditGrantResetCadence.DAILY) .resetStart(BillingPlanCreditGrantResetStart.BILLING_PERIOD) .build() );
-
-
-
request:
CreateBillingPlanCreditGrantRequestBody
-
-
client.credits.updateBillingPlanCreditGrant(planGrantId, request) -> UpdateBillingPlanCreditGrantResponse
-
-
-
client.credits().updateBillingPlanCreditGrant( "plan_grant_id", UpdateBillingPlanCreditGrantRequestBody .builder() .resetCadence(BillingPlanCreditGrantResetCadence.DAILY) .resetStart(BillingPlanCreditGrantResetStart.BILLING_PERIOD) .build() );
-
-
-
planGrantId:
String— plan_grant_id
-
request:
UpdateBillingPlanCreditGrantRequestBody
-
-
client.credits.deleteBillingPlanCreditGrant(planGrantId) -> DeleteBillingPlanCreditGrantResponse
-
-
-
client.credits().deleteBillingPlanCreditGrant( "plan_grant_id", DeleteBillingPlanCreditGrantRequest .builder() .applyToExisting(true) .build() );
-
-
-
planGrantId:
String— plan_grant_id
-
applyToExisting:
Optional<Boolean>
-
-
client.credits.countBillingPlanCreditGrants() -> CountBillingPlanCreditGrantsResponse
-
-
-
client.credits().countBillingPlanCreditGrants( CountBillingPlanCreditGrantsRequest .builder() .creditId("credit_id") .planId("plan_id") .planVersionId("plan_version_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
creditId:
Optional<String>
-
ids:
Optional<String>
-
planId:
Optional<String>
-
planIds:
Optional<String>
-
planVersionId:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.listCreditEventLedger() -> ListCreditEventLedgerResponse
-
-
-
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() );
-
-
-
billingCreditId:
Optional<String>
-
companyId:
String
-
endTime:
Optional<String>
-
eventType:
Optional<CreditEventType>
-
featureId:
Optional<String>
-
startTime:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.credits.countCreditEventLedger() -> CountCreditEventLedgerResponse
-
-
-
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() );
-
-
-
billingCreditId:
Optional<String>
-
companyId:
String
-
endTime:
Optional<String>
-
eventType:
Optional<CreditEventType>
-
featureId:
Optional<String>
-
startTime:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.checkout.internal(request) -> CheckoutInternalResponse
-
-
-
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() ) ) .creditBundles( Arrays.asList( UpdateCreditBundleRequestBody .builder() .bundleId("bundle_id") .quantity(1000000L) .build() ) ) .payInAdvance( Arrays.asList( UpdatePayInAdvanceRequestBody .builder() .priceId("price_id") .quantity(1000000L) .build() ) ) .build() );
-
-
-
request:
ChangeSubscriptionInternalRequestBody
-
-
client.checkout.getCheckoutData(request) -> GetCheckoutDataResponse
-
-
-
client.checkout().getCheckoutData( CheckoutDataRequestBody .builder() .companyId("company_id") .build() );
-
-
-
companyId:
String
-
selectedPlanId:
Optional<String>
-
-
client.checkout.previewCheckoutInternal(request) -> PreviewCheckoutInternalResponse
-
-
-
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() ) ) .creditBundles( Arrays.asList( UpdateCreditBundleRequestBody .builder() .bundleId("bundle_id") .quantity(1000000L) .build() ) ) .payInAdvance( Arrays.asList( UpdatePayInAdvanceRequestBody .builder() .priceId("price_id") .quantity(1000000L) .build() ) ) .build() );
-
-
-
request:
ChangeSubscriptionInternalRequestBody
-
-
client.checkout.managePlan(request) -> ManagePlanResponse
-
-
-
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() );
-
-
-
request:
ManagePlanRequest
-
-
client.checkout.previewManagePlan(request) -> PreviewManagePlanResponse
-
-
-
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() );
-
-
-
request:
ManagePlanRequest
-
-
client.checkout.cancelSubscription(request) -> CancelSubscriptionResponse
-
-
-
client.checkout().cancelSubscription( CancelSubscriptionRequest .builder() .companyId("company_id") .build() );
-
-
-
cancelImmediately:
Optional<Boolean>— If false, subscription cancels at period end. Defaults to true.
-
companyId:
String
-
prorate:
Optional<Boolean>— If true and cancel_immediately is true, issue prorated credit. Defaults to true.
-
-
client.checkout.updateCustomerSubscriptionTrialEnd(subscriptionId, request) -> UpdateCustomerSubscriptionTrialEndResponse
-
-
-
client.checkout().updateCustomerSubscriptionTrialEnd( "subscription_id", UpdateTrialEndRequestBody .builder() .build() );
-
-
-
subscriptionId:
String— subscription_id
-
trialEnd:
Optional<OffsetDateTime>
-
-
client.companies.listCompanies() -> ListCompaniesResponse
-
-
-
client.companies().listCompanies( ListCompaniesRequest .builder() .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() );
-
-
-
creditTypeIds:
Optional<String>— Filter companies by one or more credit type IDs (each ID starts with bcrd_)
-
ids:
Optional<String>— Filter companies by multiple company IDs (starts with comp_)
-
monetizedSubscriptions:
Optional<Boolean>— Filter companies that have monetized subscriptions
-
planId:
Optional<String>— Filter companies by plan ID (starts with plan_)
-
planIds:
Optional<String>— Filter companies by one or more plan IDs (each ID starts with plan_)
-
planVersionId:
Optional<String>— Filter companies by plan version ID (starts with plvr_)
-
q:
Optional<String>— Search for companies by name, keys or string traits
-
sortOrderColumn:
Optional<String>— Column to sort by (e.g. name, created_at, last_seen_at)
-
sortOrderDirection:
Optional<SortDirection>— Direction to sort by (asc or desc)
-
subscriptionStatuses:
Optional<SubscriptionStatus>— Filter companies by one or more subscription statuses
-
subscriptionTypes:
Optional<SubscriptionType>— Filter companies by one or more subscription types
-
withEntitlementFor:
Optional<String>— Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID
-
withoutFeatureOverrideFor:
Optional<String>— Filter out companies that already have a company override for the specified feature ID
-
withoutPlan:
Optional<Boolean>— Filter out companies that have a plan
-
withoutSubscription:
Optional<Boolean>— Filter out companies that have a subscription
-
withSubscription:
Optional<Boolean>— Filter companies that have a subscription
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.upsertCompany(request) -> UpsertCompanyResponse
-
-
-
client.companies().upsertCompany( UpsertCompanyRequestBody .builder() .keys( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
request:
UpsertCompanyRequestBody
-
-
client.companies.getCompany(companyId) -> GetCompanyResponse
-
-
-
client.companies().getCompany("company_id");
-
-
-
companyId:
String— company_id
-
-
client.companies.deleteCompany(companyId) -> DeleteCompanyResponse
-
-
-
client.companies().deleteCompany( "company_id", DeleteCompanyRequest .builder() .cancelSubscription(true) .prorate(true) .build() );
-
-
-
companyId:
String— company_id
-
cancelSubscription:
Optional<Boolean>
-
prorate:
Optional<Boolean>
-
-
client.companies.countCompanies() -> CountCompaniesResponse
-
-
-
client.companies().countCompanies( CountCompaniesRequest .builder() .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() );
-
-
-
creditTypeIds:
Optional<String>— Filter companies by one or more credit type IDs (each ID starts with bcrd_)
-
ids:
Optional<String>— Filter companies by multiple company IDs (starts with comp_)
-
monetizedSubscriptions:
Optional<Boolean>— Filter companies that have monetized subscriptions
-
planId:
Optional<String>— Filter companies by plan ID (starts with plan_)
-
planIds:
Optional<String>— Filter companies by one or more plan IDs (each ID starts with plan_)
-
planVersionId:
Optional<String>— Filter companies by plan version ID (starts with plvr_)
-
q:
Optional<String>— Search for companies by name, keys or string traits
-
sortOrderColumn:
Optional<String>— Column to sort by (e.g. name, created_at, last_seen_at)
-
sortOrderDirection:
Optional<SortDirection>— Direction to sort by (asc or desc)
-
subscriptionStatuses:
Optional<SubscriptionStatus>— Filter companies by one or more subscription statuses
-
subscriptionTypes:
Optional<SubscriptionType>— Filter companies by one or more subscription types
-
withEntitlementFor:
Optional<String>— Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID
-
withoutFeatureOverrideFor:
Optional<String>— Filter out companies that already have a company override for the specified feature ID
-
withoutPlan:
Optional<Boolean>— Filter out companies that have a plan
-
withoutSubscription:
Optional<Boolean>— Filter out companies that have a subscription
-
withSubscription:
Optional<Boolean>— Filter companies that have a subscription
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.createCompany(request) -> CreateCompanyResponse
-
-
-
client.companies().createCompany( UpsertCompanyRequestBody .builder() .keys( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
request:
UpsertCompanyRequestBody
-
-
client.companies.deleteCompanyByKeys(request) -> DeleteCompanyByKeysResponse
-
-
-
client.companies().deleteCompanyByKeys( KeysRequestBody .builder() .keys( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
request:
KeysRequestBody
-
-
client.companies.lookupCompany() -> LookupCompanyResponse
-
-
-
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:
/companies/lookup?keys={"foo": "bar", "fizz": "buzz"}/companies/lookup?keys[foo]=bar&keys[fizz]=buzz/companies/lookup?foo=bar&fizz=buzz
-
-
-
client.companies().lookupCompany( LookupCompanyRequest .builder() .keys( new HashMap<String, String>() {{ put("keys", "keys"); }} ) .build() );
-
-
-
keys:
Map<String, String>— Key/value pairs
-
-
client.companies.listCompanyMemberships() -> ListCompanyMembershipsResponse
-
-
-
client.companies().listCompanyMemberships( ListCompanyMembershipsRequest .builder() .companyId("company_id") .userId("user_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
userId:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.getOrCreateCompanyMembership(request) -> GetOrCreateCompanyMembershipResponse
-
-
-
client.companies().getOrCreateCompanyMembership( GetOrCreateCompanyMembershipRequestBody .builder() .companyId("company_id") .userId("user_id") .build() );
-
-
-
companyId:
String
-
userId:
String
-
-
client.companies.deleteCompanyMembership(companyMembershipId) -> DeleteCompanyMembershipResponse
-
-
-
client.companies().deleteCompanyMembership("company_membership_id");
-
-
-
companyMembershipId:
String— company_membership_id
-
-
client.companies.getActiveCompanySubscription() -> GetActiveCompanySubscriptionResponse
-
-
-
client.companies().getActiveCompanySubscription( GetActiveCompanySubscriptionRequest .builder() .companyId("company_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
companyIds:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.upsertCompanyTrait(request) -> UpsertCompanyTraitResponse
-
-
-
client.companies().upsertCompanyTrait( UpsertTraitRequestBody .builder() .trait("trait") .keys( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
request:
UpsertTraitRequestBody
-
-
client.companies.listEntityKeyDefinitions() -> ListEntityKeyDefinitionsResponse
-
-
-
client.companies().listEntityKeyDefinitions( ListEntityKeyDefinitionsRequest .builder() .entityType(EntityType.COMPANY) .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
entityType:
Optional<EntityType>
-
ids:
Optional<String>
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.countEntityKeyDefinitions() -> CountEntityKeyDefinitionsResponse
-
-
-
client.companies().countEntityKeyDefinitions( CountEntityKeyDefinitionsRequest .builder() .entityType(EntityType.COMPANY) .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
entityType:
Optional<EntityType>
-
ids:
Optional<String>
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.listEntityTraitDefinitions() -> ListEntityTraitDefinitionsResponse
-
-
-
client.companies().listEntityTraitDefinitions( ListEntityTraitDefinitionsRequest .builder() .entityType(EntityType.COMPANY) .q("q") .traitType(TraitType.BOOLEAN) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
entityType:
Optional<EntityType>
-
ids:
Optional<String>
-
q:
Optional<String>
-
traitType:
Optional<TraitType>
-
traitTypes:
Optional<TraitType>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.getOrCreateEntityTraitDefinition(request) -> GetOrCreateEntityTraitDefinitionResponse
-
-
-
client.companies().getOrCreateEntityTraitDefinition( CreateEntityTraitDefinitionRequestBody .builder() .entityType(EntityType.COMPANY) .traitType(TraitType.BOOLEAN) .hierarchy( Arrays.asList("hierarchy") ) .build() );
-
-
-
displayName:
Optional<String>
-
entityType:
EntityType
-
hierarchy:
List<String>
-
traitType:
TraitType
-
-
client.companies.getEntityTraitDefinition(entityTraitDefinitionId) -> GetEntityTraitDefinitionResponse
-
-
-
client.companies().getEntityTraitDefinition("entity_trait_definition_id");
-
-
-
entityTraitDefinitionId:
String— entity_trait_definition_id
-
-
client.companies.updateEntityTraitDefinition(entityTraitDefinitionId, request) -> UpdateEntityTraitDefinitionResponse
-
-
-
client.companies().updateEntityTraitDefinition( "entity_trait_definition_id", UpdateEntityTraitDefinitionRequestBody .builder() .traitType(TraitType.BOOLEAN) .build() );
-
-
-
entityTraitDefinitionId:
String— entity_trait_definition_id
-
displayName:
Optional<String>
-
traitType:
TraitType
-
-
client.companies.countEntityTraitDefinitions() -> CountEntityTraitDefinitionsResponse
-
-
-
client.companies().countEntityTraitDefinitions( CountEntityTraitDefinitionsRequest .builder() .entityType(EntityType.COMPANY) .q("q") .traitType(TraitType.BOOLEAN) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
entityType:
Optional<EntityType>
-
ids:
Optional<String>
-
q:
Optional<String>
-
traitType:
Optional<TraitType>
-
traitTypes:
Optional<TraitType>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.getEntityTraitValues() -> GetEntityTraitValuesResponse
-
-
-
client.companies().getEntityTraitValues( GetEntityTraitValuesRequest .builder() .definitionId("definition_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
definitionId:
String
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.listPlanChanges() -> ListPlanChangesResponse
-
-
-
client.companies().listPlanChanges( ListPlanChangesRequest .builder() .action("action") .basePlanAction("base_plan_action") .companyId("company_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
action:
Optional<String>
-
basePlanAction:
Optional<String>
-
companyId:
Optional<String>
-
companyIds:
Optional<String>
-
planIds:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.getPlanChange(planChangeId) -> GetPlanChangeResponse
-
-
-
client.companies().getPlanChange("plan_change_id");
-
-
-
planChangeId:
String— plan_change_id
-
-
client.companies.listPlanTraits() -> ListPlanTraitsResponse
-
-
-
client.companies().listPlanTraits( ListPlanTraitsRequest .builder() .planId("plan_id") .traitId("trait_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
planId:
Optional<String>
-
traitId:
Optional<String>
-
traitIds:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.createPlanTrait(request) -> CreatePlanTraitResponse
-
-
-
client.companies().createPlanTrait( CreatePlanTraitRequestBody .builder() .planId("plan_id") .traitId("trait_id") .traitValue("trait_value") .build() );
-
-
-
planId:
String
-
traitId:
String
-
traitValue:
String
-
-
client.companies.getPlanTrait(planTraitId) -> GetPlanTraitResponse
-
-
-
client.companies().getPlanTrait("plan_trait_id");
-
-
-
planTraitId:
String— plan_trait_id
-
-
client.companies.updatePlanTrait(planTraitId, request) -> UpdatePlanTraitResponse
-
-
-
client.companies().updatePlanTrait( "plan_trait_id", UpdatePlanTraitRequestBody .builder() .planId("plan_id") .traitValue("trait_value") .build() );
-
-
-
planTraitId:
String— plan_trait_id
-
planId:
String
-
traitValue:
String
-
-
client.companies.deletePlanTrait(planTraitId) -> DeletePlanTraitResponse
-
-
-
client.companies().deletePlanTrait("plan_trait_id");
-
-
-
planTraitId:
String— plan_trait_id
-
-
client.companies.updatePlanTraitsBulk(request) -> UpdatePlanTraitsBulkResponse
-
-
-
client.companies().updatePlanTraitsBulk( UpdatePlanTraitBulkRequestBody .builder() .applyToExistingCompanies(true) .planId("plan_id") .traits( Arrays.asList( UpdatePlanTraitTraitRequestBody .builder() .traitId("trait_id") .traitValue("trait_value") .build() ) ) .build() );
-
-
-
applyToExistingCompanies:
Boolean
-
planId:
String
-
traits:
List<UpdatePlanTraitTraitRequestBody>
-
-
client.companies.countPlanTraits() -> CountPlanTraitsResponse
-
-
-
client.companies().countPlanTraits( CountPlanTraitsRequest .builder() .planId("plan_id") .traitId("trait_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
planId:
Optional<String>
-
traitId:
Optional<String>
-
traitIds:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.upsertUserTrait(request) -> UpsertUserTraitResponse
-
-
-
client.companies().upsertUserTrait( UpsertTraitRequestBody .builder() .trait("trait") .keys( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
request:
UpsertTraitRequestBody
-
-
client.companies.listUsers() -> ListUsersResponse
-
-
-
client.companies().listUsers( ListUsersRequest .builder() .companyId("company_id") .planId("plan_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>— Filter users by company ID (starts with comp_)
-
ids:
Optional<String>— Filter users by multiple user IDs (starts with user_)
-
planId:
Optional<String>— Filter users by plan ID (starts with plan_)
-
q:
Optional<String>— Search for users by name, keys or string traits
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.upsertUser(request) -> UpsertUserResponse
-
-
-
client.companies().upsertUser( UpsertUserRequestBody .builder() .keys( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
request:
UpsertUserRequestBody
-
-
client.companies.getUser(userId) -> GetUserResponse
-
-
-
client.companies().getUser("user_id");
-
-
-
userId:
String— user_id
-
-
client.companies.deleteUser(userId) -> DeleteUserResponse
-
-
-
client.companies().deleteUser("user_id");
-
-
-
userId:
String— user_id
-
-
client.companies.countUsers() -> CountUsersResponse
-
-
-
client.companies().countUsers( CountUsersRequest .builder() .companyId("company_id") .planId("plan_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>— Filter users by company ID (starts with comp_)
-
ids:
Optional<String>— Filter users by multiple user IDs (starts with user_)
-
planId:
Optional<String>— Filter users by plan ID (starts with plan_)
-
q:
Optional<String>— Search for users by name, keys or string traits
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.companies.createUser(request) -> CreateUserResponse
-
-
-
client.companies().createUser( UpsertUserRequestBody .builder() .keys( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
request:
UpsertUserRequestBody
-
-
client.companies.deleteUserByKeys(request) -> DeleteUserByKeysResponse
-
-
-
client.companies().deleteUserByKeys( KeysRequestBody .builder() .keys( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
request:
KeysRequestBody
-
-
client.companies.lookupUser() -> LookupUserResponse
-
-
-
client.companies().lookupUser( LookupUserRequest .builder() .keys( new HashMap<String, String>() {{ put("keys", "keys"); }} ) .build() );
-
-
-
keys:
Map<String, String>— Key/value pairs
-
-
client.entitlements.listCompanyOverrides() -> ListCompanyOverridesResponse
-
-
-
client.entitlements().listCompanyOverrides( ListCompanyOverridesRequest .builder() .companyId("company_id") .featureId("feature_id") .withoutExpired(true) .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>— Filter company overrides by a single company ID (starting with comp_)
-
companyIds:
Optional<String>— Filter company overrides by multiple company IDs (starting with comp_)
-
featureId:
Optional<String>— Filter company overrides by a single feature ID (starting with feat_)
-
featureIds:
Optional<String>— Filter company overrides by multiple feature IDs (starting with feat_)
-
ids:
Optional<String>— Filter company overrides by multiple company override IDs (starting with cmov_)
-
withoutExpired:
Optional<Boolean>— Filter company overrides by whether they have not expired
-
q:
Optional<String>— Search for company overrides by feature or company name
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.createCompanyOverride(request) -> CreateCompanyOverrideResponse
-
-
-
client.entitlements().createCompanyOverride( CreateCompanyOverrideRequestBody .builder() .companyId("company_id") .featureId("feature_id") .valueType(EntitlementValueType.BOOLEAN) .build() );
-
-
-
companyId:
String
-
creditConsumptionRate:
Optional<Double>
-
expirationDate:
Optional<OffsetDateTime>
-
featureId:
String
-
metricPeriod:
Optional<CreateCompanyOverrideRequestBodyMetricPeriod>
-
metricPeriodMonthReset:
Optional<CreateCompanyOverrideRequestBodyMetricPeriodMonthReset>
-
note:
Optional<String>
-
valueBool:
Optional<Boolean>
-
valueCreditId:
Optional<String>
-
valueNumeric:
Optional<Long>
-
valueTraitId:
Optional<String>
-
valueType:
EntitlementValueType
-
-
client.entitlements.getCompanyOverride(companyOverrideId) -> GetCompanyOverrideResponse
-
-
-
client.entitlements().getCompanyOverride("company_override_id");
-
-
-
companyOverrideId:
String— company_override_id
-
-
client.entitlements.updateCompanyOverride(companyOverrideId, request) -> UpdateCompanyOverrideResponse
-
-
-
client.entitlements().updateCompanyOverride( "company_override_id", UpdateCompanyOverrideRequestBody .builder() .valueType(EntitlementValueType.BOOLEAN) .build() );
-
-
-
companyOverrideId:
String— company_override_id
-
creditConsumptionRate:
Optional<Double>
-
expirationDate:
Optional<OffsetDateTime>
-
metricPeriod:
Optional<UpdateCompanyOverrideRequestBodyMetricPeriod>
-
metricPeriodMonthReset:
Optional<UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset>
-
note:
Optional<String>
-
valueBool:
Optional<Boolean>
-
valueCreditId:
Optional<String>
-
valueNumeric:
Optional<Long>
-
valueTraitId:
Optional<String>
-
valueType:
EntitlementValueType
-
-
client.entitlements.deleteCompanyOverride(companyOverrideId) -> DeleteCompanyOverrideResponse
-
-
-
client.entitlements().deleteCompanyOverride("company_override_id");
-
-
-
companyOverrideId:
String— company_override_id
-
-
client.entitlements.countCompanyOverrides() -> CountCompanyOverridesResponse
-
-
-
client.entitlements().countCompanyOverrides( CountCompanyOverridesRequest .builder() .companyId("company_id") .featureId("feature_id") .withoutExpired(true) .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>— Filter company overrides by a single company ID (starting with comp_)
-
companyIds:
Optional<String>— Filter company overrides by multiple company IDs (starting with comp_)
-
featureId:
Optional<String>— Filter company overrides by a single feature ID (starting with feat_)
-
featureIds:
Optional<String>— Filter company overrides by multiple feature IDs (starting with feat_)
-
ids:
Optional<String>— Filter company overrides by multiple company override IDs (starting with cmov_)
-
withoutExpired:
Optional<Boolean>— Filter company overrides by whether they have not expired
-
q:
Optional<String>— Search for company overrides by feature or company name
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.listFeatureCompanies() -> ListFeatureCompaniesResponse
-
-
-
client.entitlements().listFeatureCompanies( ListFeatureCompaniesRequest .builder() .featureId("feature_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
featureId:
String
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.countFeatureCompanies() -> CountFeatureCompaniesResponse
-
-
-
client.entitlements().countFeatureCompanies( CountFeatureCompaniesRequest .builder() .featureId("feature_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
featureId:
String
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.listFeatureUsage() -> ListFeatureUsageResponse
-
-
-
client.entitlements().listFeatureUsage( ListFeatureUsageRequest .builder() .companyId("company_id") .includeUsageAggregation(true) .q("q") .withoutNegativeEntitlements(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
companyKeys:
Optional<Map<String, String>>
-
featureIds:
Optional<String>
-
includeUsageAggregation:
Optional<Boolean>— Include time-bucketed usage aggregation (today, this week, this month, billing period) for credit-based entitlements. Defaults to false for performance.
-
q:
Optional<String>
-
withoutNegativeEntitlements:
Optional<Boolean>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.getFeatureUsageTimeSeries() -> GetFeatureUsageTimeSeriesResponse
-
-
-
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() );
-
-
-
companyId:
String
-
endTime:
OffsetDateTime
-
featureId:
String
-
granularity:
Optional<TimeSeriesGranularity>
-
startTime:
OffsetDateTime
-
-
client.entitlements.countFeatureUsage() -> CountFeatureUsageResponse
-
-
-
client.entitlements().countFeatureUsage( CountFeatureUsageRequest .builder() .companyId("company_id") .includeUsageAggregation(true) .q("q") .withoutNegativeEntitlements(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
companyKeys:
Optional<Map<String, String>>
-
featureIds:
Optional<String>
-
includeUsageAggregation:
Optional<Boolean>— Include time-bucketed usage aggregation (today, this week, this month, billing period) for credit-based entitlements. Defaults to false for performance.
-
q:
Optional<String>
-
withoutNegativeEntitlements:
Optional<Boolean>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.listFeatureUsers() -> ListFeatureUsersResponse
-
-
-
client.entitlements().listFeatureUsers( ListFeatureUsersRequest .builder() .featureId("feature_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
featureId:
String
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.countFeatureUsers() -> CountFeatureUsersResponse
-
-
-
client.entitlements().countFeatureUsers( CountFeatureUsersRequest .builder() .featureId("feature_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
featureId:
String
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.listPlanEntitlements() -> ListPlanEntitlementsResponse
-
-
-
client.entitlements().listPlanEntitlements( ListPlanEntitlementsRequest .builder() .featureId("feature_id") .planId("plan_id") .planVersionId("plan_version_id") .q("q") .withMeteredProducts(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
featureId:
Optional<String>— Filter plan entitlements by a single feature ID (starting with feat_)
-
featureIds:
Optional<String>— Filter plan entitlements by multiple feature IDs (starting with feat_)
-
ids:
Optional<String>— Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)
-
planId:
Optional<String>— Filter plan entitlements by a single plan ID (starting with plan_)
-
planIds:
Optional<String>— Filter plan entitlements by multiple plan IDs (starting with plan_)
-
planVersionId:
Optional<String>— Filter plan entitlements by a single plan version ID (starting with plvr_)
-
planVersionIds:
Optional<String>— Filter plan entitlements by multiple plan version IDs (starting with plvr_)
-
q:
Optional<String>— Search for plan entitlements by feature or company name
-
withMeteredProducts:
Optional<Boolean>— Filter plan entitlements only with metered products
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.createPlanEntitlement(request) -> CreatePlanEntitlementResponse
-
-
-
client.entitlements().createPlanEntitlement( CreatePlanEntitlementRequestBody .builder() .featureId("feature_id") .planId("plan_id") .valueType(EntitlementValueType.BOOLEAN) .build() );
-
-
-
billingProductId:
Optional<String>
-
billingThreshold:
Optional<Long>
-
creditConsumptionRate:
Optional<Double>
-
currency:
Optional<String>
-
featureId:
String
-
metricPeriod:
Optional<CreatePlanEntitlementRequestBodyMetricPeriod>
-
metricPeriodMonthReset:
Optional<CreatePlanEntitlementRequestBodyMetricPeriodMonthReset>
-
monthlyMeteredPriceId:
Optional<String>
-
monthlyPriceTiers:
Optional<List<CreatePriceTierRequestBody>>
-
monthlyUnitPrice:
Optional<Long>
-
monthlyUnitPriceDecimal:
Optional<String>
-
overageBillingProductId:
Optional<String>
-
planId:
String
-
planVersionId:
Optional<String>
-
priceBehavior:
Optional<EntitlementPriceBehavior>
-
priceTiers:
Optional<List<CreatePriceTierRequestBody>>— Use MonthlyPriceTiers or YearlyPriceTiers instead
-
softLimit:
Optional<Long>
-
tierMode:
Optional<BillingTiersMode>
-
valueBool:
Optional<Boolean>
-
valueCreditId:
Optional<String>
-
valueNumeric:
Optional<Long>
-
valueTraitId:
Optional<String>
-
valueType:
EntitlementValueType
-
yearlyMeteredPriceId:
Optional<String>
-
yearlyPriceTiers:
Optional<List<CreatePriceTierRequestBody>>
-
yearlyUnitPrice:
Optional<Long>
-
yearlyUnitPriceDecimal:
Optional<String>
-
-
client.entitlements.getPlanEntitlement(planEntitlementId) -> GetPlanEntitlementResponse
-
-
-
client.entitlements().getPlanEntitlement("plan_entitlement_id");
-
-
-
planEntitlementId:
String— plan_entitlement_id
-
-
client.entitlements.updatePlanEntitlement(planEntitlementId, request) -> UpdatePlanEntitlementResponse
-
-
-
client.entitlements().updatePlanEntitlement( "plan_entitlement_id", UpdatePlanEntitlementRequestBody .builder() .valueType(EntitlementValueType.BOOLEAN) .build() );
-
-
-
planEntitlementId:
String— plan_entitlement_id
-
billingProductId:
Optional<String>
-
billingThreshold:
Optional<Long>
-
creditConsumptionRate:
Optional<Double>
-
currency:
Optional<String>
-
metricPeriod:
Optional<UpdatePlanEntitlementRequestBodyMetricPeriod>
-
metricPeriodMonthReset:
Optional<UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset>
-
monthlyMeteredPriceId:
Optional<String>
-
monthlyPriceTiers:
Optional<List<CreatePriceTierRequestBody>>
-
monthlyUnitPrice:
Optional<Long>
-
monthlyUnitPriceDecimal:
Optional<String>
-
overageBillingProductId:
Optional<String>
-
priceBehavior:
Optional<EntitlementPriceBehavior>
-
priceTiers:
Optional<List<CreatePriceTierRequestBody>>— Use MonthlyPriceTiers or YearlyPriceTiers instead
-
softLimit:
Optional<Long>
-
tierMode:
Optional<BillingTiersMode>
-
valueBool:
Optional<Boolean>
-
valueCreditId:
Optional<String>
-
valueNumeric:
Optional<Long>
-
valueTraitId:
Optional<String>
-
valueType:
EntitlementValueType
-
yearlyMeteredPriceId:
Optional<String>
-
yearlyPriceTiers:
Optional<List<CreatePriceTierRequestBody>>
-
yearlyUnitPrice:
Optional<Long>
-
yearlyUnitPriceDecimal:
Optional<String>
-
-
client.entitlements.deletePlanEntitlement(planEntitlementId) -> DeletePlanEntitlementResponse
-
-
-
client.entitlements().deletePlanEntitlement("plan_entitlement_id");
-
-
-
planEntitlementId:
String— plan_entitlement_id
-
-
client.entitlements.countPlanEntitlements() -> CountPlanEntitlementsResponse
-
-
-
client.entitlements().countPlanEntitlements( CountPlanEntitlementsRequest .builder() .featureId("feature_id") .planId("plan_id") .planVersionId("plan_version_id") .q("q") .withMeteredProducts(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
featureId:
Optional<String>— Filter plan entitlements by a single feature ID (starting with feat_)
-
featureIds:
Optional<String>— Filter plan entitlements by multiple feature IDs (starting with feat_)
-
ids:
Optional<String>— Filter plan entitlements by multiple plan entitlement IDs (starting with pltl_)
-
planId:
Optional<String>— Filter plan entitlements by a single plan ID (starting with plan_)
-
planIds:
Optional<String>— Filter plan entitlements by multiple plan IDs (starting with plan_)
-
planVersionId:
Optional<String>— Filter plan entitlements by a single plan version ID (starting with plvr_)
-
planVersionIds:
Optional<String>— Filter plan entitlements by multiple plan version IDs (starting with plvr_)
-
q:
Optional<String>— Search for plan entitlements by feature or company name
-
withMeteredProducts:
Optional<Boolean>— Filter plan entitlements only with metered products
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.entitlements.duplicatePlanEntitlements(request) -> DuplicatePlanEntitlementsResponse
-
-
-
client.entitlements().duplicatePlanEntitlements( DuplicatePlanEntitlementsRequestBody .builder() .sourcePlanId("source_plan_id") .targetPlanId("target_plan_id") .build() );
-
-
-
sourcePlanId:
String
-
targetPlanId:
String
-
-
client.entitlements.getFeatureUsageByCompany() -> GetFeatureUsageByCompanyResponse
-
-
-
client.entitlements().getFeatureUsageByCompany( GetFeatureUsageByCompanyRequest .builder() .keys( new HashMap<String, String>() {{ put("keys", "keys"); }} ) .build() );
-
-
-
keys:
Map<String, String>— Key/value pairs
-
-
client.plans.updateCompanyPlans(companyPlanId, request) -> UpdateCompanyPlansResponse
-
-
-
client.plans().updateCompanyPlans( "company_plan_id", UpdateCompanyPlansRequestBody .builder() .addOnIds( Arrays.asList("add_on_ids") ) .build() );
-
-
-
companyPlanId:
String— company_plan_id
-
addOnIds:
List<String>
-
basePlanId:
Optional<String>
-
-
client.plans.listPlans() -> ListPlansResponse
-
-
-
client.plans().listPlans( ListPlansRequest .builder() .companyId("company_id") .forFallbackPlan(true) .forInitialPlan(true) .forTrialExpiryPlan(true) .hasProductId(true) .includeDraftVersions(true) .planType(PlanType.PLAN) .q("q") .withoutEntitlementFor("without_entitlement_for") .withoutPaidProductId(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
forFallbackPlan:
Optional<Boolean>— Filter for plans valid as fallback plans (not linked to billing)
-
forInitialPlan:
Optional<Boolean>— Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)
-
forTrialExpiryPlan:
Optional<Boolean>— Filter for plans valid as trial expiry plans (not linked to billing or free)
-
hasProductId:
Optional<Boolean>— Filter out plans that do not have a billing product ID
-
ids:
Optional<String>
-
includeDraftVersions:
Optional<Boolean>— Include billing settings from draft versions for plans which have draft version
-
planType:
Optional<PlanType>— Filter by plan type
-
q:
Optional<String>
-
withoutEntitlementFor:
Optional<String>— Filter out plans that already have a plan entitlement for the specified feature ID
-
withoutPaidProductId:
Optional<Boolean>— Filter out plans that have a paid billing product ID
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.plans.createPlan(request) -> CreatePlanResponse
-
-
-
client.plans().createPlan( CreatePlanRequestBody .builder() .description("description") .name("name") .planType(PlanType.PLAN) .build() );
-
-
-
request:
CreatePlanRequestBody
-
-
client.plans.getPlan(planId) -> GetPlanResponse
-
-
-
client.plans().getPlan( "plan_id", GetPlanRequest .builder() .planVersionId("plan_version_id") .build() );
-
-
-
planId:
String— plan_id
-
planVersionId:
Optional<String>— Fetch billing settings for a specific plan version
-
-
client.plans.updatePlan(planId, request) -> UpdatePlanResponse
-
-
-
client.plans().updatePlan( "plan_id", UpdatePlanRequestBody .builder() .name("name") .build() );
-
-
-
planId:
String— plan_id
-
request:
UpdatePlanRequestBody
-
-
client.plans.deletePlan(planId) -> DeletePlanResponse
-
-
-
client.plans().deletePlan("plan_id");
-
-
-
planId:
String— plan_id
-
-
client.plans.upsertBillingProductPlan(planId, request) -> UpsertBillingProductPlanResponse
-
-
-
client.plans().upsertBillingProductPlan( "plan_id", UpsertBillingProductRequestBody .builder() .chargeType(ChargeType.FREE) .isTrialable(true) .build() );
-
-
-
planId:
String— plan_id
-
request:
UpsertBillingProductRequestBody
-
-
client.plans.countPlans() -> CountPlansResponse
-
-
-
client.plans().countPlans( CountPlansRequest .builder() .companyId("company_id") .forFallbackPlan(true) .forInitialPlan(true) .forTrialExpiryPlan(true) .hasProductId(true) .includeDraftVersions(true) .planType(PlanType.PLAN) .q("q") .withoutEntitlementFor("without_entitlement_for") .withoutPaidProductId(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
forFallbackPlan:
Optional<Boolean>— Filter for plans valid as fallback plans (not linked to billing)
-
forInitialPlan:
Optional<Boolean>— Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial)
-
forTrialExpiryPlan:
Optional<Boolean>— Filter for plans valid as trial expiry plans (not linked to billing or free)
-
hasProductId:
Optional<Boolean>— Filter out plans that do not have a billing product ID
-
ids:
Optional<String>
-
includeDraftVersions:
Optional<Boolean>— Include billing settings from draft versions for plans which have draft version
-
planType:
Optional<PlanType>— Filter by plan type
-
q:
Optional<String>
-
withoutEntitlementFor:
Optional<String>— Filter out plans that already have a plan entitlement for the specified feature ID
-
withoutPaidProductId:
Optional<Boolean>— Filter out plans that have a paid billing product ID
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.plans.listPlanIssues() -> ListPlanIssuesResponse
-
-
-
client.plans().listPlanIssues( ListPlanIssuesRequest .builder() .planId("plan_id") .planVersionId("plan_version_id") .build() );
-
-
-
planId:
String
-
planVersionId:
Optional<String>
-
-
client.plans.deletePlanVersion(planId) -> DeletePlanVersionResponse
-
-
-
client.plans().deletePlanVersion( "plan_id", DeletePlanVersionRequest .builder() .promoteArchivedVersion(true) .build() );
-
-
-
planId:
String— plan_id
-
promoteArchivedVersion:
Optional<Boolean>
-
-
client.plans.publishPlanVersion(planId, request) -> PublishPlanVersionResponse
-
-
-
client.plans().publishPlanVersion( "plan_id", PublishPlanVersionRequestBody .builder() .migrationStrategy(PlanVersionMigrationStrategy.IMMEDIATE) .excludedCompanyIds( Arrays.asList("excluded_company_ids") ) .build() );
-
-
-
planId:
String— plan_id
-
excludedCompanyIds:
List<String>
-
migrationStrategy:
PlanVersionMigrationStrategy
-
-
client.components.listComponents() -> ListComponentsResponse
-
-
-
client.components().listComponents( ListComponentsRequest .builder() .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.components.createComponent(request) -> CreateComponentResponse
-
-
-
client.components().createComponent( CreateComponentRequestBody .builder() .entityType(ComponentEntityType.BILLING) .name("name") .build() );
-
-
-
ast:
Optional<Map<String, Double>>
-
entityType:
ComponentEntityType
-
name:
String
-
-
client.components.getComponent(componentId) -> GetComponentResponse
-
-
-
client.components().getComponent("component_id");
-
-
-
componentId:
String— component_id
-
-
client.components.updateComponent(componentId, request) -> UpdateComponentResponse
-
-
-
client.components().updateComponent( "component_id", UpdateComponentRequestBody .builder() .build() );
-
-
-
componentId:
String— component_id
-
ast:
Optional<Map<String, Double>>
-
entityType:
Optional<ComponentEntityType>
-
name:
Optional<String>
-
state:
Optional<ComponentState>
-
-
client.components.deleteComponent(componentId) -> DeleteComponentResponse
-
-
-
client.components().deleteComponent("component_id");
-
-
-
componentId:
String— component_id
-
-
client.components.countComponents() -> CountComponentsResponse
-
-
-
client.components().countComponents( CountComponentsRequest .builder() .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.components.previewComponentData() -> PreviewComponentDataResponse
-
-
-
client.components().previewComponentData( PreviewComponentDataRequest .builder() .companyId("company_id") .componentId("component_id") .build() );
-
-
-
companyId:
Optional<String>
-
componentId:
Optional<String>
-
-
client.dataexports.createDataExport(request) -> CreateDataExportResponse
-
-
-
client.dataexports().createDataExport( CreateDataExportRequestBody .builder() .exportType("company-feature-usage") .metadata("metadata") .outputFileType("csv") .build() );
-
-
-
exportType:
String
-
metadata:
String
-
outputFileType:
String
-
-
client.dataexports.getDataExportArtifact(dataExportId) -> InputStream
-
-
-
client.dataexports().getDataExportArtifact("data_export_id");
-
-
-
dataExportId:
String— data_export_id
-
-
client.events.createEventBatch(request) -> CreateEventBatchResponse
-
-
-
client.events().createEventBatch( CreateEventBatchRequestBody .builder() .events( Arrays.asList( CreateEventRequestBody .builder() .eventType(EventType.FLAG_CHECK) .build() ) ) .build() );
-
-
-
events:
List<CreateEventRequestBody>
-
-
client.events.getEventSummaries() -> GetEventSummariesResponse
-
-
-
client.events().getEventSummaries( GetEventSummariesRequest .builder() .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
q:
Optional<String>
-
eventSubtypes:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.events.listEvents() -> ListEventsResponse
-
-
-
client.events().listEvents( ListEventsRequest .builder() .companyId("company_id") .eventSubtype("event_subtype") .flagId("flag_id") .userId("user_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
eventSubtype:
Optional<String>
-
eventTypes:
Optional<EventType>
-
flagId:
Optional<String>
-
userId:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.events.createEvent(request) -> CreateEventResponse
-
-
-
client.events().createEvent( CreateEventRequestBody .builder() .eventType(EventType.FLAG_CHECK) .build() );
-
-
-
request:
CreateEventRequestBody
-
-
client.events.getEvent(eventId) -> GetEventResponse
-
-
-
client.events().getEvent("event_id");
-
-
-
eventId:
String— event_id
-
-
client.events.getSegmentIntegrationStatus() -> GetSegmentIntegrationStatusResponse
-
-
-
client.events().getSegmentIntegrationStatus();
-
-
client.features.listFeatures() -> ListFeaturesResponse
-
-
-
client.features().listFeatures( ListFeaturesRequest .builder() .q("q") .withoutCompanyOverrideFor("without_company_override_for") .planVersionId("plan_version_id") .withoutPlanEntitlementFor("without_plan_entitlement_for") .booleanRequireEvent(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
q:
Optional<String>— Search by feature name or ID
-
withoutCompanyOverrideFor:
Optional<String>— Filter out features that already have a company override for the specified company ID
-
planVersionId:
Optional<String>— Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used
-
withoutPlanEntitlementFor:
Optional<String>— Filter out features that already have a plan entitlement for the specified plan ID
-
featureType:
Optional<FeatureType>— Filter by one or more feature types (boolean, event, trait)
-
booleanRequireEvent:
Optional<Boolean>— Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter.
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.features.createFeature(request) -> CreateFeatureResponse
-
-
-
client.features().createFeature( CreateFeatureRequestBody .builder() .description("description") .featureType(FeatureType.BOOLEAN) .name("name") .build() );
-
-
-
description:
String
-
eventSubtype:
Optional<String>
-
featureType:
FeatureType
-
flag:
Optional<CreateOrUpdateFlagRequestBody>
-
icon:
Optional<String>
-
lifecyclePhase:
Optional<FeatureLifecyclePhase>
-
maintainerId:
Optional<String>
-
name:
String
-
pluralName:
Optional<String>
-
singularName:
Optional<String>
-
traitId:
Optional<String>
-
-
client.features.getFeature(featureId) -> GetFeatureResponse
-
-
-
client.features().getFeature("feature_id");
-
-
-
featureId:
String— feature_id
-
-
client.features.updateFeature(featureId, request) -> UpdateFeatureResponse
-
-
-
client.features().updateFeature( "feature_id", UpdateFeatureRequestBody .builder() .build() );
-
-
-
featureId:
String— feature_id
-
description:
Optional<String>
-
eventSubtype:
Optional<String>
-
featureType:
Optional<FeatureType>
-
flag:
Optional<CreateOrUpdateFlagRequestBody>
-
icon:
Optional<String>
-
lifecyclePhase:
Optional<FeatureLifecyclePhase>
-
maintainerId:
Optional<String>
-
name:
Optional<String>
-
pluralName:
Optional<String>
-
singularName:
Optional<String>
-
traitId:
Optional<String>
-
-
client.features.deleteFeature(featureId) -> DeleteFeatureResponse
-
-
-
client.features().deleteFeature("feature_id");
-
-
-
featureId:
String— feature_id
-
-
client.features.countFeatures() -> CountFeaturesResponse
-
-
-
client.features().countFeatures( CountFeaturesRequest .builder() .q("q") .withoutCompanyOverrideFor("without_company_override_for") .planVersionId("plan_version_id") .withoutPlanEntitlementFor("without_plan_entitlement_for") .booleanRequireEvent(true) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
q:
Optional<String>— Search by feature name or ID
-
withoutCompanyOverrideFor:
Optional<String>— Filter out features that already have a company override for the specified company ID
-
planVersionId:
Optional<String>— Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used
-
withoutPlanEntitlementFor:
Optional<String>— Filter out features that already have a plan entitlement for the specified plan ID
-
featureType:
Optional<FeatureType>— Filter by one or more feature types (boolean, event, trait)
-
booleanRequireEvent:
Optional<Boolean>— Only return boolean features if there is an associated event. Automatically includes boolean in the feature types filter.
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.features.listFlags() -> ListFlagsResponse
-
-
-
client.features().listFlags( ListFlagsRequest .builder() .featureId("feature_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
featureId:
Optional<String>
-
ids:
Optional<String>
-
q:
Optional<String>— Search by flag name, key, or ID
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.features.createFlag(request) -> CreateFlagResponse
-
-
-
client.features().createFlag( CreateFlagRequestBody .builder() .defaultValue(true) .description("description") .flagType("boolean") .key("key") .name("name") .build() );
-
-
-
request:
CreateFlagRequestBody
-
-
client.features.getFlag(flagId) -> GetFlagResponse
-
-
-
client.features().getFlag("flag_id");
-
-
-
flagId:
String— flag_id
-
-
client.features.updateFlag(flagId, request) -> UpdateFlagResponse
-
-
-
client.features().updateFlag( "flag_id", CreateFlagRequestBody .builder() .defaultValue(true) .description("description") .flagType("boolean") .key("key") .name("name") .build() );
-
-
-
flagId:
String— flag_id
-
request:
CreateFlagRequestBody
-
-
client.features.deleteFlag(flagId) -> DeleteFlagResponse
-
-
-
client.features().deleteFlag("flag_id");
-
-
-
flagId:
String— flag_id
-
-
client.features.updateFlagRules(flagId, request) -> UpdateFlagRulesResponse
-
-
-
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(CreateOrUpdateConditionRequestBodyConditionType.COMPANY) .operator(CreateOrUpdateConditionRequestBodyOperator.EQ) .resourceIds( Arrays.asList("resource_ids") ) .build() ) ) .build() ) ) .conditions( Arrays.asList( CreateOrUpdateConditionRequestBody .builder() .conditionType(CreateOrUpdateConditionRequestBodyConditionType.COMPANY) .operator(CreateOrUpdateConditionRequestBodyOperator.EQ) .resourceIds( Arrays.asList("resource_ids") ) .build() ) ) .build() ) ) .build() );
-
-
-
flagId:
String— flag_id
-
rules:
List<CreateOrUpdateRuleRequestBody>
-
-
client.features.checkFlag(key, request) -> CheckFlagResponse
-
-
-
client.features().checkFlag( "key", CheckFlagRequestBody .builder() .build() );
-
-
-
key:
String— key
-
request:
CheckFlagRequestBody
-
-
client.features.checkFlags(request) -> CheckFlagsResponse
-
-
-
client.features().checkFlags( CheckFlagRequestBody .builder() .build() );
-
-
-
request:
CheckFlagRequestBody
-
-
client.features.checkFlagsBulk(request) -> CheckFlagsBulkResponse
-
-
-
client.features().checkFlagsBulk( CheckFlagsBulkRequestBody .builder() .contexts( Arrays.asList( CheckFlagRequestBody .builder() .build() ) ) .build() );
-
-
-
contexts:
List<CheckFlagRequestBody>
-
-
client.features.countFlags() -> CountFlagsResponse
-
-
-
client.features().countFlags( CountFlagsRequest .builder() .featureId("feature_id") .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
featureId:
Optional<String>
-
ids:
Optional<String>
-
q:
Optional<String>— Search by flag name, key, or ID
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.planbundle.createPlanBundle(request) -> CreatePlanBundleResponse
-
-
-
client.planbundle().createPlanBundle( CreatePlanBundleRequestBody .builder() .entitlements( Arrays.asList( PlanBundleEntitlementRequestBody .builder() .action(PlanBundleAction.CREATE) .build() ) ) .build() );
-
-
-
billingProduct:
Optional<UpsertBillingProductRequestBody>
-
creditGrants:
Optional<List<PlanBundleCreditGrantRequestBody>>
-
entitlements:
List<PlanBundleEntitlementRequestBody>
-
plan:
Optional<CreatePlanRequestBody>
-
traits:
Optional<List<UpdatePlanTraitTraitRequestBody>>
-
-
client.planbundle.updatePlanBundle(planBundleId, request) -> UpdatePlanBundleResponse
-
-
-
client.planbundle().updatePlanBundle( "plan_bundle_id", UpdatePlanBundleRequestBody .builder() .entitlements( Arrays.asList( PlanBundleEntitlementRequestBody .builder() .action(PlanBundleAction.CREATE) .build() ) ) .build() );
-
-
-
planBundleId:
String— plan_bundle_id
-
billingProduct:
Optional<UpsertBillingProductRequestBody>
-
creditGrants:
Optional<List<PlanBundleCreditGrantRequestBody>>
-
entitlements:
List<PlanBundleEntitlementRequestBody>
-
plan:
Optional<UpdatePlanRequestBody>
-
planVersionId:
Optional<String>
-
traits:
Optional<List<UpdatePlanTraitTraitRequestBody>>
-
-
client.plangroups.getPlanGroup() -> GetPlanGroupResponse
-
-
-
client.plangroups().getPlanGroup( GetPlanGroupRequest .builder() .includeCompanyCounts(true) .build() );
-
-
-
includeCompanyCounts:
Optional<Boolean>
-
-
client.plangroups.createPlanGroup(request) -> CreatePlanGroupResponse
-
-
-
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() );
-
-
-
addOnCompatibilities:
Optional<List<CompatiblePlans>>
-
addOnIds:
List<String>— Use OrderedAddOns instead
-
checkoutCollectAddress:
Boolean
-
checkoutCollectEmail:
Boolean
-
checkoutCollectPhone:
Boolean
-
customPlanConfig:
Optional<CustomPlanConfig>
-
customPlanId:
Optional<String>
-
enableTaxCollection:
Boolean
-
fallbackPlanId:
Optional<String>
-
initialPlanId:
Optional<String>
-
initialPlanPriceId:
Optional<String>
-
orderedAddOns:
List<OrderedPlansInGroup>
-
orderedBundleList:
List<PlanGroupBundleOrder>
-
orderedPlans:
List<OrderedPlansInGroup>
-
preventDowngradesWhenOverLimit:
Boolean
-
preventSelfServiceDowngrade:
Boolean
-
preventSelfServiceDowngradeButtonText:
Optional<String>
-
preventSelfServiceDowngradeUrl:
Optional<String>
-
prorationBehavior:
ProrationBehavior
-
scheduledDowngradeBehavior:
Optional<ScheduledDowngradeConfigBehavior>
-
scheduledDowngradePreventWhenOverLimit:
Optional<Boolean>
-
showAsMonthlyPrices:
Boolean
-
showCredits:
Boolean
-
showFeatureDescription:
Boolean
-
showHardLimit:
Boolean
-
showPeriodToggle:
Boolean
-
showZeroPriceAsFree:
Boolean
-
syncCustomerBillingDetails:
Boolean
-
trialDays:
Optional<Long>
-
trialExpiryPlanId:
Optional<String>
-
trialExpiryPlanPriceId:
Optional<String>
-
trialPaymentMethodRequired:
Optional<Boolean>
-
-
client.plangroups.updatePlanGroup(planGroupId, request) -> UpdatePlanGroupResponse
-
-
-
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() );
-
-
-
planGroupId:
String— plan_group_id
-
addOnCompatibilities:
Optional<List<CompatiblePlans>>
-
addOnIds:
List<String>— Use OrderedAddOns instead
-
checkoutCollectAddress:
Boolean
-
checkoutCollectEmail:
Boolean
-
checkoutCollectPhone:
Boolean
-
customPlanConfig:
Optional<CustomPlanConfig>
-
customPlanId:
Optional<String>
-
enableTaxCollection:
Boolean
-
fallbackPlanId:
Optional<String>
-
initialPlanId:
Optional<String>
-
initialPlanPriceId:
Optional<String>
-
orderedAddOns:
List<OrderedPlansInGroup>
-
orderedBundleList:
List<PlanGroupBundleOrder>
-
orderedPlans:
List<OrderedPlansInGroup>
-
preventDowngradesWhenOverLimit:
Boolean
-
preventSelfServiceDowngrade:
Boolean
-
preventSelfServiceDowngradeButtonText:
Optional<String>
-
preventSelfServiceDowngradeUrl:
Optional<String>
-
prorationBehavior:
ProrationBehavior
-
scheduledDowngradeBehavior:
Optional<ScheduledDowngradeConfigBehavior>
-
scheduledDowngradePreventWhenOverLimit:
Optional<Boolean>
-
showAsMonthlyPrices:
Boolean
-
showCredits:
Boolean
-
showFeatureDescription:
Boolean
-
showHardLimit:
Boolean
-
showPeriodToggle:
Boolean
-
showZeroPriceAsFree:
Boolean
-
syncCustomerBillingDetails:
Boolean
-
trialDays:
Optional<Long>
-
trialExpiryPlanId:
Optional<String>
-
trialExpiryPlanPriceId:
Optional<String>
-
trialPaymentMethodRequired:
Optional<Boolean>
-
-
client.planmigrations.listCompanyMigrations() -> ListCompanyMigrationsResponse
-
-
-
client.planmigrations().listCompanyMigrations( ListCompanyMigrationsRequest .builder() .migrationId("migration_id") .q("q") .status(PlanVersionCompanyMigrationStatus.COMPLETED) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
migrationId:
Optional<String>
-
q:
Optional<String>
-
status:
Optional<PlanVersionCompanyMigrationStatus>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.planmigrations.countCompanyMigrations() -> CountCompanyMigrationsResponse
-
-
-
client.planmigrations().countCompanyMigrations( CountCompanyMigrationsRequest .builder() .migrationId("migration_id") .q("q") .status(PlanVersionCompanyMigrationStatus.COMPLETED) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
migrationId:
Optional<String>
-
q:
Optional<String>
-
status:
Optional<PlanVersionCompanyMigrationStatus>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.planmigrations.listMigrations() -> ListMigrationsResponse
-
-
-
client.planmigrations().listMigrations( ListMigrationsRequest .builder() .planVersionId("plan_version_id") .status(PlanVersionMigrationStatus.COMPLETED) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
planVersionId:
Optional<String>
-
status:
Optional<PlanVersionMigrationStatus>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.planmigrations.getMigration(planVersionMigrationId) -> GetMigrationResponse
-
-
-
client.planmigrations().getMigration("plan_version_migration_id");
-
-
-
planVersionMigrationId:
String— plan_version_migration_id
-
-
client.planmigrations.countMigrations() -> CountMigrationsResponse
-
-
-
client.planmigrations().countMigrations( CountMigrationsRequest .builder() .planVersionId("plan_version_id") .status(PlanVersionMigrationStatus.COMPLETED) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
planVersionId:
Optional<String>
-
status:
Optional<PlanVersionMigrationStatus>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.componentspublic.getPublicPlans() -> GetPublicPlansResponse
-
-
-
client.componentspublic().getPublicPlans();
-
-
client.scheduledcheckout.listScheduledCheckouts() -> ListScheduledCheckoutsResponse
-
-
-
client.scheduledcheckout().listScheduledCheckouts( ListScheduledCheckoutsRequest .builder() .companyId("company_id") .status(ScheduledCheckoutStatus.CANCELLED) .limit(1000000L) .offset(1000000L) .build() );
-
-
-
companyId:
Optional<String>
-
status:
Optional<ScheduledCheckoutStatus>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.scheduledcheckout.createScheduledCheckout(request) -> CreateScheduledCheckoutResponse
-
-
-
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() );
-
-
-
companyId:
String
-
executeAfter:
OffsetDateTime
-
fromPlanId:
String
-
toPlanId:
String
-
-
client.scheduledcheckout.getScheduledCheckout(scheduledCheckoutId) -> GetScheduledCheckoutResponse
-
-
-
client.scheduledcheckout().getScheduledCheckout("scheduled_checkout_id");
-
-
-
scheduledCheckoutId:
String— scheduled_checkout_id
-
-
client.scheduledcheckout.updateScheduledCheckout(scheduledCheckoutId, request) -> UpdateScheduledCheckoutResponse
-
-
-
client.scheduledcheckout().updateScheduledCheckout( "scheduled_checkout_id", UpdateScheduledCheckoutRequest .builder() .build() );
-
-
-
scheduledCheckoutId:
String— scheduled_checkout_id
-
executeAfter:
Optional<OffsetDateTime>
-
status:
Optional<ScheduledCheckoutStatus>
-
-
client.accesstokens.issueTemporaryAccessToken(request) -> IssueTemporaryAccessTokenResponse
-
-
-
client.accesstokens().issueTemporaryAccessToken( IssueTemporaryAccessTokenRequestBody .builder() .resourceType("company") .lookup( new HashMap<String, String>() {{ put("key", "value"); }} ) .build() );
-
-
-
lookup:
Map<String, String>
-
resourceType:
String
-
-
client.webhooks.listWebhookEvents() -> ListWebhookEventsResponse
-
-
-
client.webhooks().listWebhookEvents( ListWebhookEventsRequest .builder() .q("q") .webhookId("webhook_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
q:
Optional<String>
-
webhookId:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.webhooks.getWebhookEvent(webhookEventId) -> GetWebhookEventResponse
-
-
-
client.webhooks().getWebhookEvent("webhook_event_id");
-
-
-
webhookEventId:
String— webhook_event_id
-
-
client.webhooks.countWebhookEvents() -> CountWebhookEventsResponse
-
-
-
client.webhooks().countWebhookEvents( CountWebhookEventsRequest .builder() .q("q") .webhookId("webhook_id") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
ids:
Optional<String>
-
q:
Optional<String>
-
webhookId:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.webhooks.listWebhooks() -> ListWebhooksResponse
-
-
-
client.webhooks().listWebhooks( ListWebhooksRequest .builder() .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-
client.webhooks.createWebhook(request) -> CreateWebhookResponse
-
-
-
client.webhooks().createWebhook( CreateWebhookRequestBody .builder() .name("name") .url("url") .requestTypes( Arrays.asList(WebhookRequestType.SUBSCRIPTION_TRIAL_ENDED) ) .build() );
-
-
-
creditTriggerConfigs:
Optional<List<CreditTriggerConfig>>
-
entitlementTriggerConfigs:
Optional<List<EntitlementTriggerConfig>>
-
name:
String
-
requestTypes:
List<WebhookRequestType>
-
url:
String
-
-
client.webhooks.getWebhook(webhookId) -> GetWebhookResponse
-
-
-
client.webhooks().getWebhook("webhook_id");
-
-
-
webhookId:
String— webhook_id
-
-
client.webhooks.updateWebhook(webhookId, request) -> UpdateWebhookResponse
-
-
-
client.webhooks().updateWebhook( "webhook_id", UpdateWebhookRequestBody .builder() .build() );
-
-
-
webhookId:
String— webhook_id
-
creditTriggerConfigs:
Optional<List<CreditTriggerConfig>>
-
entitlementTriggerConfigs:
Optional<List<EntitlementTriggerConfig>>
-
name:
Optional<String>
-
requestTypes:
Optional<List<WebhookRequestType>>
-
status:
Optional<WebhookStatus>
-
url:
Optional<String>
-
-
client.webhooks.deleteWebhook(webhookId) -> DeleteWebhookResponse
-
-
-
client.webhooks().deleteWebhook("webhook_id");
-
-
-
webhookId:
String— webhook_id
-
-
client.webhooks.countWebhooks() -> CountWebhooksResponse
-
-
-
client.webhooks().countWebhooks( CountWebhooksRequest .builder() .q("q") .limit(1000000L) .offset(1000000L) .build() );
-
-
-
q:
Optional<String>
-
limit:
Optional<Long>— Page limit (default 100)
-
offset:
Optional<Long>— Page offset (default 0)
-
-