Files
sdk/docs/SubscriptionsApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

10 KiB

SubscriptionsApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
commerceCancelSubscription DELETE /v1/commerce/subscribe/{subscriptionid} Cancel subscription
commerceCreateSubscription POST /v1/commerce/subscribe Create subscription
commerceGetSubscription GET /v1/commerce/subscribe/{subscriptionid} Get subscription
commerceUpdateSubscription PATCH /v1/commerce/subscribe/{subscriptionid} Update subscription
pricingListBlockchainPlans GET /v1/pricing/blockchain Blockchain / RPC plans
pricingListPlans GET /v1/pricing/plans Subscription plans
pricingListSubscriptions GET /v1/pricing/subscriptions Subscription plans

commerceCancelSubscription

CommerceSubscription commerceCancelSubscription(subscriptionid)

Cancel subscription

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = SubscriptionsApi()
val subscriptionid : kotlin.String = subscriptionid_example // kotlin.String | 
try {
    val result : CommerceSubscription = apiInstance.commerceCancelSubscription(subscriptionid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionsApi#commerceCancelSubscription")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionsApi#commerceCancelSubscription")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
subscriptionid kotlin.String

Return type

CommerceSubscription

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

commerceCreateSubscription

CommerceSubscription commerceCreateSubscription(commerceSubscriptionRequest)

Create subscription

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = SubscriptionsApi()
val commerceSubscriptionRequest : CommerceSubscriptionRequest =  // CommerceSubscriptionRequest | 
try {
    val result : CommerceSubscription = apiInstance.commerceCreateSubscription(commerceSubscriptionRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionsApi#commerceCreateSubscription")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionsApi#commerceCreateSubscription")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
commerceSubscriptionRequest CommerceSubscriptionRequest

Return type

CommerceSubscription

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

commerceGetSubscription

CommerceSubscription commerceGetSubscription(subscriptionid)

Get subscription

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = SubscriptionsApi()
val subscriptionid : kotlin.String = subscriptionid_example // kotlin.String | 
try {
    val result : CommerceSubscription = apiInstance.commerceGetSubscription(subscriptionid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionsApi#commerceGetSubscription")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionsApi#commerceGetSubscription")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
subscriptionid kotlin.String

Return type

CommerceSubscription

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

commerceUpdateSubscription

CommerceSubscription commerceUpdateSubscription(subscriptionid, commerceSubscription)

Update subscription

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = SubscriptionsApi()
val subscriptionid : kotlin.String = subscriptionid_example // kotlin.String | 
val commerceSubscription : CommerceSubscription =  // CommerceSubscription | 
try {
    val result : CommerceSubscription = apiInstance.commerceUpdateSubscription(subscriptionid, commerceSubscription)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionsApi#commerceUpdateSubscription")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionsApi#commerceUpdateSubscription")
    e.printStackTrace()
}

Parameters

| subscriptionid | kotlin.String| | |

Name Type Description Notes
commerceSubscription CommerceSubscription

Return type

CommerceSubscription

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

pricingListBlockchainPlans

PricingListBlockchainPlans200Response pricingListBlockchainPlans()

Blockchain / RPC plans

Returns blockchain node and RPC access plans.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = SubscriptionsApi()
try {
    val result : PricingListBlockchainPlans200Response = apiInstance.pricingListBlockchainPlans()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionsApi#pricingListBlockchainPlans")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionsApi#pricingListBlockchainPlans")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

PricingListBlockchainPlans200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

pricingListPlans

PricingSubscriptionPlansResponse pricingListPlans()

Subscription plans

Returns platform subscription plans across the personal, team, world, social, and enterprise categories (e.g. Developer, Pro, Max, Team, World Free/Pro/Team/Enterprise). Alias for /v1/pricing/subscriptions.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = SubscriptionsApi()
try {
    val result : PricingSubscriptionPlansResponse = apiInstance.pricingListPlans()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionsApi#pricingListPlans")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionsApi#pricingListPlans")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

PricingSubscriptionPlansResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

pricingListSubscriptions

PricingSubscriptionPlansResponse pricingListSubscriptions()

Subscription plans

Returns platform subscription plans with pricing, features, rate limits, and revenue sharing details.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = SubscriptionsApi()
try {
    val result : PricingSubscriptionPlansResponse = apiInstance.pricingListSubscriptions()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SubscriptionsApi#pricingListSubscriptions")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SubscriptionsApi#pricingListSubscriptions")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

PricingSubscriptionPlansResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json