The Dodo Payments Kotlin SDK provides convenient access to the Dodo Payments REST API from applications written in Kotlin.
The Dodo Payments Kotlin SDK is similar to the Dodo Payments Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of Optional
, Sequence
instead of Stream
, and suspend functions instead of CompletableFuture
.
It is generated with Stainless.
The REST API documentation can be found on docs.dodopayments.com. KDocs are available on javadoc.io.
implementation("com.dodopayments.api:dodo-payments-kotlin:1.32.0")
<dependency>
<groupId>com.dodopayments.apigroupId>
<artifactId>dodo-payments-kotlinartifactId>
<version>1.32.0version>
dependency>
This library requires Java 8 or later.
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.misc.CountryCode
import com.dodopayments.api.models.payments.AttachExistingCustomer
import com.dodopayments.api.models.payments.BillingAddress
import com.dodopayments.api.models.payments.OneTimeProductCartItem
import com.dodopayments.api.models.payments.PaymentCreateParams
import com.dodopayments.api.models.payments.PaymentCreateResponse
// Configures using the `DODO_PAYMENTS_API_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
val params: PaymentCreateParams = PaymentCreateParams.builder()
.billing(BillingAddress.builder()
.city("city")
.country(CountryCode.AF)
.state("state")
.street("street")
.zipcode("zipcode")
.build())
.customer(AttachExistingCustomer.builder()
.customerId("customer_id")
.build())
.addProductCart(OneTimeProductCartItem.builder()
.productId("product_id")
.quantity(0)
.build())
.build()
val payment: PaymentCreateResponse = client.payments().create(params)
Configure the client using environment variables:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
// Configures using the `DODO_PAYMENTS_API_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
Or manually:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.builder()
.bearerToken("My Bearer Token")
.build()
Or using a combination of the two approaches:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.builder()
// Configures using the `DODO_PAYMENTS_API_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
.fromEnv()
.bearerToken("My Bearer Token")
.build()
See this table for the available options:
Setter | Environment variable | Required | Default value |
---|---|---|---|
bearerToken |
DODO_PAYMENTS_API_KEY |
true | - |
baseUrl |
DODO_PAYMENTS_BASE_URL |
true | "https://live.dodopayments.com" |
Tip
Don't create more than one client in the same application. Each client has a connection pool and thread pools, which are more efficient to share between requests.
To send a request to the Dodo Payments API, build an instance of some Params
class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.
For example, client.payments().create(...)
should be called with an instance of PaymentCreateParams
, and it will return an instance of PaymentCreateResponse
.
Each class in the SDK has an associated builder or factory method for constructing it.
Each class is immutable once constructed. If the class has an associated builder, then it has a toBuilder()
method, which can be used to convert it back to a builder for making a modified copy.
Because each class is immutable, builder modification will never affect already built class instances.
The default client is synchronous. To switch to asynchronous execution, call the async()
method:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.misc.CountryCode
import com.dodopayments.api.models.payments.AttachExistingCustomer
import com.dodopayments.api.models.payments.BillingAddress
import com.dodopayments.api.models.payments.OneTimeProductCartItem
import com.dodopayments.api.models.payments.PaymentCreateParams
import com.dodopayments.api.models.payments.PaymentCreateResponse
// Configures using the `DODO_PAYMENTS_API_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
val params: PaymentCreateParams = PaymentCreateParams.builder()
.billing(BillingAddress.builder()
.city("city")
.country(CountryCode.AF)
.state("state")
.street("street")
.zipcode("zipcode")
.build())
.customer(AttachExistingCustomer.builder()
.customerId("customer_id")
.build())
.addProductCart(OneTimeProductCartItem.builder()
.productId("product_id")
.quantity(0)
.build())
.build()
val payment: PaymentCreateResponse = client.async().payments().create(params)
Or create an asynchronous client from the beginning:
import com.dodopayments.api.client.DodoPaymentsClientAsync
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClientAsync
import com.dodopayments.api.models.misc.CountryCode
import com.dodopayments.api.models.payments.AttachExistingCustomer
import com.dodopayments.api.models.payments.BillingAddress
import com.dodopayments.api.models.payments.OneTimeProductCartItem
import com.dodopayments.api.models.payments.PaymentCreateParams
import com.dodopayments.api.models.payments.PaymentCreateResponse
// Configures using the `DODO_PAYMENTS_API_KEY` and `DODO_PAYMENTS_BASE_URL` environment variables
val client: DodoPaymentsClientAsync = DodoPaymentsOkHttpClientAsync.fromEnv()
val params: PaymentCreateParams = PaymentCreateParams.builder()
.billing(BillingAddress.builder()
.city("city")
.country(CountryCode.AF)
.state("state")
.street("street")
.zipcode("zipcode")
.build())
.customer(AttachExistingCustomer.builder()
.customerId("customer_id")
.build())
.addProductCart(OneTimeProductCartItem.builder()
.productId("product_id")
.quantity(0)
.build())
.build()
val payment: PaymentCreateResponse = client.payments().create(params)
The asynchronous client supports the same options as the synchronous one, except most methods are suspending.
The SDK defines methods that return binary responses, which are used for API responses that shouldn't necessarily be parsed, like non-JSON data.
These methods return HttpResponse
:
import com.dodopayments.api.core.http.HttpResponse
import com.dodopayments.api.models.invoices.payments.PaymentRetrieveParams
val payment: HttpResponse = client.invoices().payments().retrieve("payment_id")
To save the response content to a file, use the Files.copy(...)
method:
import java.nio.file.Files
import java.nio.file.Paths
import java.nio.file.StandardCopyOption
client.invoices().payments().retrieve(params).use {
Files.copy(
it.body(),
Paths.get(path),
StandardCopyOption.REPLACE_EXISTING
)
}
Or transfer the response content to any OutputStream
:
import java.nio.file.Files
import java.nio.file.Paths
client.invoices().payments().retrieve(params).use {
it.body().transferTo(Files.newOutputStream(Paths.get(path)))
}
The SDK defines methods that deserialize responses into instances of Kotlin classes. However, these methods don't provide access to the response headers, status code, or the raw response body.
To access this data, prefix any HTTP method call on a client or service with withRawResponse()
:
import com.dodopayments.api.core.http.Headers
import com.dodopayments.api.core.http.HttpResponseFor
import com.dodopayments.api.models.misc.CountryCode
import com.dodopayments.api.models.payments.AttachExistingCustomer
import com.dodopayments.api.models.payments.BillingAddress
import com.dodopayments.api.models.payments.OneTimeProductCartItem
import com.dodopayments.api.models.payments.PaymentCreateParams
import com.dodopayments.api.models.payments.PaymentCreateResponse
val params: PaymentCreateParams = PaymentCreateParams.builder()
.billing(BillingAddress.builder()
.city("city")
.country(CountryCode.AF)
.state("state")
.street("street")
.zipcode("zipcode")
.build())
.customer(AttachExistingCustomer.builder()
.customerId("customer_id")
.build())
.addProductCart(OneTimeProductCartItem.builder()
.productId("product_id")
.quantity(0)
.build())
.build()
val payment: HttpResponseFor<PaymentCreateResponse> = client.payments().withRawResponse().create(params)
val statusCode: Int = payment.statusCode()
val headers: Headers = payment.headers()
You can still deserialize the response into an instance of a Kotlin class if needed:
import com.dodopayments.api.models.payments.PaymentCreateResponse
val parsedPayment: PaymentCreateResponse = payment.parse()
The SDK throws custom unchecked exception types:
-
DodoPaymentsServiceException
: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:Status Exception 400 BadRequestException
401 UnauthorizedException
403 PermissionDeniedException
404 NotFoundException
422 UnprocessableEntityException
429 RateLimitException
5xx InternalServerException
others UnexpectedStatusCodeException
-
DodoPaymentsIoException
: I/O networking errors. -
DodoPaymentsInvalidDataException
: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response. -
DodoPaymentsException
: Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.
The SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.
To iterate through all results across all pages, use the autoPager()
method, which automatically fetches more pages as needed.
When using the synchronous client, the method returns a Sequence
import com.dodopayments.api.models.payments.PaymentListPage
val page: PaymentListPage = client.payments().list()
page.autoPager()
.take(50)
.forEach { payment -> println(payment) }
When using the asynchronous client, the method returns a Flow
:
import com.dodopayments.api.models.payments.PaymentListPageAsync
val page: PaymentListPageAsync = client.async().payments().list()
page.autoPager()
.take(50)
.forEach { payment -> println(payment) }
To access individual page items and manually request the next page, use the items()
,
hasNextPage()
, and nextPage()
methods:
import com.dodopayments.api.models.payments.PaymentListPage
import com.dodopayments.api.models.payments.PaymentListResponse
val page: PaymentListPage = client.payments().list()
while (true) {
for (payment in page.items()) {
println(payment)
}
if (!page.hasNextPage()) {
break
}
page = page.nextPage()
}
The SDK uses the standard OkHttp logging interceptor.
Enable logging by setting the DODO_PAYMENTS_LOG
environment variable to info
:
$ export DODO_PAYMENTS_LOG=info
Or to debug
for more verbose logging:
$ export DODO_PAYMENTS_LOG=debug
The SDK depends on Jackson for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.
The SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).
If the SDK threw an exception, but you're certain the version is compatible, then disable the version check using the checkJacksonVersionCompatibility
on DodoPaymentsOkHttpClient
or DodoPaymentsOkHttpClientAsync
.
Caution
We make no guarantee that the SDK works correctly when the Jackson version check is disabled.
The SDK automatically retries 2 times by default, with a short exponential backoff.
Only the following error types are retried:
- Connection errors (for example, due to a network connectivity problem)
- 408 Request Timeout
- 409 Conflict
- 429 Rate Limit
- 5xx Internal
The API may also explicitly instruct the SDK to retry or not retry a response.
To set a custom number of retries, configure the client using the maxRetries
method:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.builder()
.fromEnv()
.maxRetries(4)
.build()
Requests time out after 1 minute by default.
To set a custom timeout, configure the method call using the timeout
method:
import com.dodopayments.api.models.payments.PaymentCreateResponse
val payment: PaymentCreateResponse = client.payments().create(
params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
)
Or configure the default for all method calls at the client level:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import java.time.Duration
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.builder()
.fromEnv()
.timeout(Duration.ofSeconds(30))
.build()
To route requests through a proxy, configure the client using the proxy
method:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import java.net.InetSocketAddress
import java.net.Proxy
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.builder()
.fromEnv()
.proxy(Proxy(
Proxy.Type.HTTP, InetSocketAddress(
"https://example.com", 8080
)
))
.build()
The SDK sends requests to the live_mode by default. To send requests to a different environment, configure the client like so:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.builder()
.fromEnv()
.testMode()
.build()
The SDK consists of three artifacts:
dodo-payments-kotlin-core
- Contains core SDK logic
- Does not depend on OkHttp
- Exposes
DodoPaymentsClient
,DodoPaymentsClientAsync
,DodoPaymentsClientImpl
, andDodoPaymentsClientAsyncImpl
, all of which can work with any HTTP client
dodo-payments-kotlin-client-okhttp
- Depends on OkHttp
- Exposes
DodoPaymentsOkHttpClient
andDodoPaymentsOkHttpClientAsync
, which provide a way to constructDodoPaymentsClientImpl
andDodoPaymentsClientAsyncImpl
, respectively, using OkHttp
dodo-payments-kotlin
- Depends on and exposes the APIs of both
dodo-payments-kotlin-core
anddodo-payments-kotlin-client-okhttp
- Does not have its own logic
- Depends on and exposes the APIs of both
This structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.
Customized OkHttpClient
Tip
Try the available network options before replacing the default client.
To use a customized OkHttpClient
:
- Replace your
dodo-payments-kotlin
dependency withdodo-payments-kotlin-core
- Copy
dodo-payments-kotlin-client-okhttp
'sOkHttpClient
class into your code and customize it - Construct
DodoPaymentsClientImpl
orDodoPaymentsClientAsyncImpl
, similarly toDodoPaymentsOkHttpClient
orDodoPaymentsOkHttpClientAsync
, using your customized client
To use a completely custom HTTP client:
- Replace your
dodo-payments-kotlin
dependency withdodo-payments-kotlin-core
- Write a class that implements the
HttpClient
interface - Construct
DodoPaymentsClientImpl
orDodoPaymentsClientAsyncImpl
, similarly toDodoPaymentsOkHttpClient
orDodoPaymentsOkHttpClientAsync
, using your new client class
The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.
To set undocumented parameters, call the putAdditionalHeader
, putAdditionalQueryParam
, or putAdditionalBodyProperty
methods on any Params
class:
import com.dodopayments.api.core.JsonValue
import com.dodopayments.api.models.payments.PaymentCreateParams
val params: PaymentCreateParams = PaymentCreateParams.builder()
.putAdditionalHeader("Secret-Header", "42")
.putAdditionalQueryParam("secret_query_param", "42")
.putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))
.build()
These can be accessed on the built object later using the _additionalHeaders()
, _additionalQueryParams()
, and _additionalBodyProperties()
methods.
To set undocumented parameters on nested headers, query params, or body classes, call the putAdditionalProperty
method on the nested class:
import com.dodopayments.api.core.JsonValue
import com.dodopayments.api.models.payments.BillingAddress
import com.dodopayments.api.models.payments.PaymentCreateParams
val params: PaymentCreateParams = PaymentCreateParams.builder()
.billing(BillingAddress.builder()
.putAdditionalProperty("secretProperty", JsonValue.from("42"))
.build())
.build()
These properties can be accessed on the nested built object later using the _additionalProperties()
method.
To set a documented parameter or property to an undocumented or not yet supported value, pass a JsonValue
object to its setter:
import com.dodopayments.api.core.JsonValue
import com.dodopayments.api.models.payments.AttachExistingCustomer
import com.dodopayments.api.models.payments.OneTimeProductCartItem
import com.dodopayments.api.models.payments.PaymentCreateParams
val params: PaymentCreateParams = PaymentCreateParams.builder()
.billing(JsonValue.from(42))
.customer(AttachExistingCustomer.builder()
.customerId("customer_id")
.build())
.addProductCart(OneTimeProductCartItem.builder()
.productId("product_id")
.quantity(0)
.build())
.build()
The most straightforward way to create a JsonValue
is using its from(...)
method:
import com.dodopayments.api.core.JsonValue
// Create primitive JSON values
val nullValue: JsonValue = JsonValue.from(null)
val booleanValue: JsonValue = JsonValue.from(true)
val numberValue: JsonValue = JsonValue.from(42)
val stringValue: JsonValue = JsonValue.from("Hello World!")
// Create a JSON array value equivalent to `["Hello", "World"]`
val arrayValue: JsonValue = JsonValue.from(listOf(
"Hello", "World"
))
// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`
val objectValue: JsonValue = JsonValue.from(mapOf(
"a" to 1, "b" to 2
))
// Create an arbitrarily nested JSON equivalent to:
// {
// "a": [1, 2],
// "b": [3, 4]
// }
val complexValue: JsonValue = JsonValue.from(mapOf(
"a" to listOf(
1, 2
), "b" to listOf(
3, 4
)
))
Normally a Builder
class's build
method will throw IllegalStateException
if any required parameter or property is unset.
To forcibly omit a required parameter or property, pass JsonMissing
:
import com.dodopayments.api.core.JsonMissing
import com.dodopayments.api.models.payments.AttachExistingCustomer
import com.dodopayments.api.models.payments.OneTimeProductCartItem
import com.dodopayments.api.models.payments.PaymentCreateParams
val params: PaymentCreateParams = PaymentCreateParams.builder()
.customer(AttachExistingCustomer.builder()
.customerId("customer_id")
.build())
.addProductCart(OneTimeProductCartItem.builder()
.productId("product_id")
.quantity(0)
.build())
.billing(JsonMissing.of())
.build()
To access undocumented response properties, call the _additionalProperties()
method:
import com.dodopayments.api.core.JsonBoolean
import com.dodopayments.api.core.JsonNull
import com.dodopayments.api.core.JsonNumber
import com.dodopayments.api.core.JsonValue
val additionalProperties: Map<String, JsonValue> = client.payments().create(params)._additionalProperties()
val secretPropertyValue: JsonValue = additionalProperties.get("secretProperty")
val result = when (secretPropertyValue) {
is JsonNull -> "It's null!"
is JsonBoolean -> "It's a boolean!"
is JsonNumber -> "It's a number!"
// Other types include `JsonMissing`, `JsonString`, `JsonArray`, and `JsonObject`
else -> "It's something else!"
}
To access a property's raw JSON value, which may be undocumented, call its _
prefixed method:
import com.dodopayments.api.core.JsonField
import com.dodopayments.api.models.payments.BillingAddress
val billing: JsonField<BillingAddress> = client.payments().create(params)._billing()
if (billing.isMissing()) {
// The property is absent from the JSON response
} else if (billing.isNull()) {
// The property was set to literal null
} else {
// Check if value was provided as a string
// Other methods include `asNumber()`, `asBoolean()`, etc.
val jsonString: String? = billing.asString();
// Try to deserialize into a custom type
val myObject: MyClass = billing.asUnknown()!!.convert(MyClass::class.java)
}
In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a String
, but the API could return something else.
By default, the SDK will not throw an exception in this case. It will throw DodoPaymentsInvalidDataException
only if you directly access the property.
If you would prefer to check that the response is completely well-typed upfront, then either call validate()
:
import com.dodopayments.api.models.payments.PaymentCreateResponse
val payment: PaymentCreateResponse = client.payments().create(params).validate()
Or configure the method call to validate the response using the responseValidation
method:
import com.dodopayments.api.models.payments.PaymentCreateResponse
val payment: PaymentCreateResponse = client.payments().create(
params, RequestOptions.builder().responseValidation(true).build()
)
Or configure the default for all method calls at the client level:
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.builder()
.fromEnv()
.responseValidation(true)
.build()
Kotlin enum
classes are not trivially forwards compatible. Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.
Using JsonField
enables a few features:
- Allowing usage of undocumented API functionality
- Lazily validating the API response against the expected shape
- Representing absent vs explicitly null values
Why don't you use data
classes?
It is not backwards compatible to add new fields to a data class and we don't want to introduce a breaking change every time we add a field to a class.
Checked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.
Checked exceptions:
- Are verbose to handle
- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error
- Are tedious to propagate due to the function coloring problem
- Don't play well with lambdas (also due to the function coloring problem)
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.