Create Addon

Create a new addon product that can be attached to your main subscription products

POST /addons

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const addonResponse = await client.addons.create({
  currency: 'AED',
  name: 'name',
  price: 0,
  tax_category: 'digital_products',
});

console.log(addonResponse.id);

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
addon_response = client.addons.create(
    currency="AED",
    name="name",
    price=0,
    tax_category="digital_products",
)
print(addon_response.id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	addonResponse, err := client.Addons.New(context.TODO(), dodopayments.AddonNewParams{
		Currency:    dodopayments.F(dodopayments.CurrencyAed),
		Name:        dodopayments.F("name"),
		Price:       dodopayments.F(int64(0)),
		TaxCategory: dodopayments.F(dodopayments.TaxCategoryDigitalProducts),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", addonResponse.ID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.addons.AddonCreateParams;
import com.dodopayments.api.models.addons.AddonResponse;
import com.dodopayments.api.models.misc.Currency;
import com.dodopayments.api.models.misc.TaxCategory;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        AddonCreateParams params = AddonCreateParams.builder()
            .currency(Currency.AED)
            .name("name")
            .price(0)
            .taxCategory(TaxCategory.DIGITAL_PRODUCTS)
            .build();
        AddonResponse addonResponse = client.addons().create(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.addons.AddonCreateParams
import com.dodopayments.api.models.addons.AddonResponse
import com.dodopayments.api.models.misc.Currency
import com.dodopayments.api.models.misc.TaxCategory

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: AddonCreateParams = AddonCreateParams.builder()
        .currency(Currency.AED)
        .name("name")
        .price(0)
        .taxCategory(TaxCategory.DIGITAL_PRODUCTS)
        .build()
    val addonResponse: AddonResponse = client.addons().create(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

addon_response = dodo_payments.addons.create(currency: :AED, name: "name", price: 0, tax_category: :digital_products)

puts(addon_response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\Misc\Currency;
use Dodopayments\Misc\TaxCategory;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $addonResponse = $client->addons->create(
    currency: Currency::AED,
    name: 'name',
    price: 0,
    taxCategory: TaxCategory::DIGITAL_PRODUCTS,
    description: 'description',
  );

  var_dump($addonResponse);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Addons;
using DodoPayments.Client.Models.Misc;

DodoPaymentsClient client = new();

AddonCreateParams parameters = new()
{
    Currency = Currency.Aed,
    Name = "name",
    Price = 0,
    TaxCategory = TaxCategory.DigitalProducts,
};

var addonResponse = await client.Addons.Create(parameters);

Console.WriteLine(addonResponse);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .addons()
        .create()
        .body(dodopayments::models::AddonsCreateParams {
                currency: Some(Box::new(dodopayments::models::Currency::Aed)),
                name: Some("name".to_string()),
                price: Some(0),
                tax_category: Some(Box::new(dodopayments::models::TaxCategory::DigitalProducts)),
                ..Default::default()
            })
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request POST \
  --url https://test.dodopayments.com/addons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "price": 123,
  "description": "<string>"
}
'

200

{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "price": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "image": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

currency · enum<string> · required

The currency of the Addon

Available options: AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW

name · string · required

Name of the Addon

price · integer<int32> · required

Amount of the addon

tax_category · enum<string> · required

Tax category applied to this Addon

Available options: digital_products, saas, e_book, edtech

description · string | null

Optional description of the Addon

Response

200

application/json

Create a new addon

business_id · string · required

Unique identifier for the business to which the addon belongs.

created_at · string<date-time> · required

Created time

currency · enum<string> · required

Currency of the Addon

Available options: AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW

id · string · required

id of the Addon

name · string · required

Name of the Addon

price · integer<int32> · required

Amount of the addon

tax_category · enum<string> · required

Tax category applied to this Addon

Available options: digital_products, saas, e_book, edtech

updated_at · string<date-time> · required

Updated time

description · string | null

Optional description of the Addon

image · string | null

Image of the Addon