Get Product Detail

GET

products

{id}

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: 'My Bearer Token',
});

const product = await client.products.retrieve('id');

console.log(product.brand_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"),
  )
  product, err := client.Products.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", product.BrandID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.products.Product;
import com.dodopayments.api.models.products.ProductRetrieveParams;

public final class Main {
    private Main() {}

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

        Product product = client.products().retrieve("id");
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.products.Product
import com.dodopayments.api.models.products.ProductRetrieveParams

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

    val product: Product = client.products().retrieve("id")
}

require "dodopayments"

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

product = dodo_payments.products.retrieve("id")

puts(product)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/products/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "brand_id": "<string>",
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_recurring": true,
  "license_key_enabled": true,
  "metadata": {},
  "price": {
    "currency": "AED",
    "discount": 123,
    "price": 123,
    "purchasing_power_parity": true,
    "type": "one_time_price",
    "pay_what_you_want": true,
    "suggested_price": 123,
    "tax_inclusive": true
  },
  "product_id": "<string>",
  "tax_category": "digital_products",
  "updated_at": "2023-11-07T05:31:56Z",
  "addons": [
    "<string>"
  ],
  "description": "<string>",
  "digital_product_delivery": {
    "external_url": "<string>",
    "files": [
      {
        "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "file_name": "<string>",
        "url": "<string>"
      }
    ],
    "instructions": "<string>"
  },
  "image": "<string>",
  "license_key_activation_message": "<string>",
  "license_key_activations_limit": 123,
  "license_key_duration": {
    "count": 123,
    "interval": "Day"
  },
  "name": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Product Id

Response

Product Details

brand_id

string

required

business_id

string

required

Unique identifier for the business to which the product belongs.

created_at

string<date-time>

required

Timestamp when the product was created.

is_recurring

boolean

required

Indicates if the product is recurring (e.g., subscriptions).

license_key_enabled

boolean

required

Indicates whether the product requires a license key.

metadata

object

required

Additional custom data associated with the product

Show child attributes

price

One Time Price · object

required

Pricing information for the product.

One Time Price
Recurring Price
Usage Based Price

Show child attributes

product_id

string

required

Unique identifier for the product.

tax_category

enum<string>

required

Tax category associated with the product.

Available options:

digital_products,

saas,

e_book,

edtech

updated_at

string<date-time>

required

Timestamp when the product was last updated.

addons

string[] | null

Available Addons for subscription products

description

string | null

Description of the product, optional.

digital_product_delivery

null | Digital Product Delivery · object

Show child attributes

image

string | null

URL of the product image, optional.

license_key_activation_message

string | null

Message sent upon license key activation, if applicable.

license_key_activations_limit

integer<int32> | null

Limit on the number of activations for the license key, if enabled.

license_key_duration

null | License Key Duration · object

Duration of the license key validity, if enabled.

Show child attributes

name

string | null

Name of the product, optional.

⌘I

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: 'My Bearer Token',
});

const product = await client.products.retrieve('id');

console.log(product.brand_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"),
  )
  product, err := client.Products.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", product.BrandID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.products.Product;
import com.dodopayments.api.models.products.ProductRetrieveParams;

public final class Main {
    private Main() {}

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

        Product product = client.products().retrieve("id");
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.products.Product
import com.dodopayments.api.models.products.ProductRetrieveParams

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

    val product: Product = client.products().retrieve("id")
}

require "dodopayments"

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

product = dodo_payments.products.retrieve("id")

puts(product)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/products/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "brand_id": "<string>",
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_recurring": true,
  "license_key_enabled": true,
  "metadata": {},
  "price": {
    "currency": "AED",
    "discount": 123,
    "price": 123,
    "purchasing_power_parity": true,
    "type": "one_time_price",
    "pay_what_you_want": true,
    "suggested_price": 123,
    "tax_inclusive": true
  },
  "product_id": "<string>",
  "tax_category": "digital_products",
  "updated_at": "2023-11-07T05:31:56Z",
  "addons": [
    "<string>"
  ],
  "description": "<string>",
  "digital_product_delivery": {
    "external_url": "<string>",
    "files": [
      {
        "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "file_name": "<string>",
        "url": "<string>"
      }
    ],
    "instructions": "<string>"
  },
  "image": "<string>",
  "license_key_activation_message": "<string>",
  "license_key_activations_limit": 123,
  "license_key_duration": {
    "count": 123,
    "interval": "Day"
  },
  "name": "<string>"
}

API Reference

Checkout Sessions

Payments

Subscriptions

Discounts

Licenses

Customers

Customer Wallets

Products

Addons

Meters

Usage Events

Refunds

Disputes

Payouts

Brands

Webhooks

Miscellaneous

Authorizations

Path Parameters

Response