declare(strict_types=1);
require 'vendor/autoload.php';
use Dub;
use Dub\Models\Operations;
$sdk = Dub\Dub::builder()
->setSecurity(
'DUB_API_KEY'
)
->build();
$request = new Operations\RequestBody2(
type: Operations\CreateCommissionRequestBodyType::Lead,
partnerId: '<id>',
lead: new Operations\Lead(
eventName: 'Sign up',
),
);
$response = $sdk->commissions->create(
request: $request
);
if ($response->object !== null) {
// handle response
}package main
import(
"context"
dubgo "github.com/dubinc/dub-go"
"github.com/dubinc/dub-go/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := dubgo.New(
dubgo.WithSecurity("DUB_API_KEY"),
)
res, err := s.Commissions.Create(ctx, dubgo.Pointer(operations.CreateCreateCommissionRequestBodyRequestBody2(
operations.RequestBody2{
Type: operations.CreateCommissionRequestBodyTypeLead,
PartnerID: "<id>",
Lead: &operations.Lead{
EventName: dubgo.Pointer("Sign up"),
},
},
)))
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}require 'dub'
Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Dub.new(
security: Models::Shared::Security.new(
token: 'DUB_API_KEY'
)
)
req = Models::Operations::RequestBody2.new(
type: Models::Operations::CreateCommissionRequestBodyType::LEAD,
partner_id: '<id>',
lead: Models::Operations::Lead.new(
event_name: 'Sign up'
),
lead_event_name: 'Sign up'
)
res = s.commissions.create(request: req)
unless res.nil?
# handle response
endimport { Dub } from "dub";
const dub = new Dub({
token: "DUB_API_KEY",
});
async function run() {
const result = await dub.commissions.create();
console.log(result);
}
run();from dub import Dub
from dub.models import operations
with Dub(
token="DUB_API_KEY",
) as d_client:
res = d_client.commissions.create(request={
"type": operations.CreateCommissionRequestBodyType.LEAD,
"partner_id": "<id>",
"lead_event_name": "Sign up",
})
# Handle response
print(res)curl --request POST \
--url https://api.dub.co/commissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "custom",
"partnerId": "<string>",
"amount": 123,
"date": "<string>",
"description": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'custom',
partnerId: '<string>',
amount: 123,
date: '<string>',
description: '<string>'
})
};
fetch('https://api.dub.co/commissions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.dub.co/commissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"custom\",\n \"partnerId\": \"<string>\",\n \"amount\": 123,\n \"date\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();{
"success": true,
"message": "<string>"
}{
"error": {
"code": "bad_request",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#bad-request"
}
}{
"error": {
"code": "unauthorized",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"
}
}{
"error": {
"code": "forbidden",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#forbidden"
}
}{
"error": {
"code": "not_found",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#not-found"
}
}{
"error": {
"code": "conflict",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#conflict"
}
}{
"error": {
"code": "invite_expired",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"
}
}{
"error": {
"code": "unprocessable_entity",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"
}
}{
"error": {
"code": "internal_server_error",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"
}
}Create commission
Create one or more commissions (custom, lead or sale) for a partner. Custom commissions accept a negative amount to create a clawback. Commission creation is processed asynchronously – use the GET /commissions endpoint or webhooks to be notified when the commission is created.
declare(strict_types=1);
require 'vendor/autoload.php';
use Dub;
use Dub\Models\Operations;
$sdk = Dub\Dub::builder()
->setSecurity(
'DUB_API_KEY'
)
->build();
$request = new Operations\RequestBody2(
type: Operations\CreateCommissionRequestBodyType::Lead,
partnerId: '<id>',
lead: new Operations\Lead(
eventName: 'Sign up',
),
);
$response = $sdk->commissions->create(
request: $request
);
if ($response->object !== null) {
// handle response
}package main
import(
"context"
dubgo "github.com/dubinc/dub-go"
"github.com/dubinc/dub-go/models/operations"
"log"
)
func main() {
ctx := context.Background()
s := dubgo.New(
dubgo.WithSecurity("DUB_API_KEY"),
)
res, err := s.Commissions.Create(ctx, dubgo.Pointer(operations.CreateCreateCommissionRequestBodyRequestBody2(
operations.RequestBody2{
Type: operations.CreateCommissionRequestBodyTypeLead,
PartnerID: "<id>",
Lead: &operations.Lead{
EventName: dubgo.Pointer("Sign up"),
},
},
)))
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}require 'dub'
Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::Dub.new(
security: Models::Shared::Security.new(
token: 'DUB_API_KEY'
)
)
req = Models::Operations::RequestBody2.new(
type: Models::Operations::CreateCommissionRequestBodyType::LEAD,
partner_id: '<id>',
lead: Models::Operations::Lead.new(
event_name: 'Sign up'
),
lead_event_name: 'Sign up'
)
res = s.commissions.create(request: req)
unless res.nil?
# handle response
endimport { Dub } from "dub";
const dub = new Dub({
token: "DUB_API_KEY",
});
async function run() {
const result = await dub.commissions.create();
console.log(result);
}
run();from dub import Dub
from dub.models import operations
with Dub(
token="DUB_API_KEY",
) as d_client:
res = d_client.commissions.create(request={
"type": operations.CreateCommissionRequestBodyType.LEAD,
"partner_id": "<id>",
"lead_event_name": "Sign up",
})
# Handle response
print(res)curl --request POST \
--url https://api.dub.co/commissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "custom",
"partnerId": "<string>",
"amount": 123,
"date": "<string>",
"description": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'custom',
partnerId: '<string>',
amount: 123,
date: '<string>',
description: '<string>'
})
};
fetch('https://api.dub.co/commissions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.dub.co/commissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"custom\",\n \"partnerId\": \"<string>\",\n \"amount\": 123,\n \"date\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();{
"success": true,
"message": "<string>"
}{
"error": {
"code": "bad_request",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#bad-request"
}
}{
"error": {
"code": "unauthorized",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"
}
}{
"error": {
"code": "forbidden",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#forbidden"
}
}{
"error": {
"code": "not_found",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#not-found"
}
}{
"error": {
"code": "conflict",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#conflict"
}
}{
"error": {
"code": "invite_expired",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"
}
}{
"error": {
"code": "unprocessable_entity",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"
}
}{
"error": {
"code": "internal_server_error",
"message": "The requested resource was not found.",
"doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"
}
}Authorizations
Default authentication mechanism
Body
- Option 1
- Option 2
- Option 3
custom The ID of the partner to create the commission for.
The commission earnings amount in cents. Use a negative amount to create a clawback.
If not provided, the current date will be used.
The description of the commission. Required for clawbacks (negative amount). May be a known clawback reason (order_canceled, fraud, terms_violation, tracking_error, payment_failed, ineligible_partner, duplicate_commission) or an arbitrary string (max 190 characters).
190Was this page helpful?