Welcome to the dodopayments SDK documentation. This guide will help you get started with integrating and using the dodopayments SDK in your project.
- API version:
0.19.0 - SDK version:
0.19.0
- Setup & Configuration
- Authentication
- Environments
- Setting a Custom Timeout
- Sample Usage
- Services
- Models
- License
This SDK is compatible with the following versions: PHP >= 8.0
To get started with the SDK, we recommend installing using composer:
composer require dodopayments/clientThe dodopayments API uses an Access Token for authentication.
This token must be provided to authenticate your requests to the API.
When you initialize the SDK, you can set the access token as follows:
new Client(accessToken: "YOUR_ACCESS_TOKEN");If you need to set or update the access token after initializing the SDK, you can use:
sdk.setAccessToken("YOUR_ACCESS_TOKEN")The SDK supports different environments for various stages of development and deployment.
Here are the available environments:
const Default = "https://live.dodopayments.com"
const LiveMode = "https://live.dodopayments.com"
const TestMode = "https://test.dodopayments.com"To configure the SDK to use a specific environment, you can set the base URL as follows:
$sdk->setBaseUrl(Environment::live_mode);You can set a custom timeout for the SDK's HTTP requests as follows:
$sdk = new Client(timeout: 1000);Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
<?php
use Dodopayments\Client;
$sdk = new Client(accessToken: 'YOUR_TOKEN');
$response = $sdk->checkout->getSupportedCountriesProxy();
print_r($response);The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
| Name |
|---|
| Checkout |
| Customers |
| Disputes |
| Invoices |
| LicenseKeys |
| Licenses |
| Payments |
| Payouts |
| Products |
| Refunds |
| Subscriptions |
| WebhookEvents |
| OutgoingWebhooks |
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
This SDK is licensed under the Apache-2.0 License.
See the LICENSE file for more details.