Products API — create a product catalog

The products API lets you build a catalog of the goods and services you sell. Once you create a product, you can reference it by ID when adding line items to invoices or building checkout links — saving you from re-entering details each time. Products support physical goods, digital downloads, and services, with optional tax and discount configuration. All routes require authentication.

Product object

string

Unique product identifier (UUID).

string

Product name.

string

Optional description of the product (up to 2,000 characters).

string

Product type. One of physical, digital, or service.

number

Unit price in the product’s currency.

string

Currency of the price. One of NGN or USD. Defaults to your account’s default currency.

string

One of active, inactive, or archived. Only active products can be used in new invoices and checkout links.

number

Optional stock count. null means unlimited stock.

array

Up to 10 image URLs associated with this product.

string

How tax is applied: none, percentage, or fixed.

number

Tax amount. Interpreted as a percentage when tax_type is percentage, or as a fixed currency amount when fixed.

string

How discounts are applied: none, percentage, or fixed.

number

Discount amount. Interpreted as a percentage or fixed amount depending on discount_type.

string

ISO 8601 creation timestamp.

string

ISO 8601 last-updated timestamp.

Create a product

POST /products

Request body

string

required

Product name. Maximum 255 characters.

string

Optional product description. Maximum 2,000 characters.

string

Product type: physical, digital, or service.

number

required

Unit price. Must be a positive number.

string

NGN or USD. Defaults to your account currency.

number

Stock count. Omit for unlimited stock.

array

Array of image URLs. Maximum 10 items.

string

none, percentage, or fixed. Defaults to none.

number

Tax amount. Required when tax_type is not none.

string

none, percentage, or fixed. Defaults to none.

number

Discount amount. Required when discount_type is not none.

Example

curl -X POST https://api.dubupay.com/api/v1/products \
  -H "X-Api-Key: dubu_sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Annual SaaS Subscription",
    "description": "Access to all premium features for one year.",
    "type": "digital",
    "price": 120000,
    "currency": "NGN"
  }'

Returns 201 Created with the new product object.

List products

GET /products

Returns a paginated list of your products.

Query parameters

string

Filter by status: active, inactive, or archived.

string

Full-text search across product names.

number

Page number (1-indexed). Defaults to 1.

number

Results per page. Maximum 100.

Example

curl "https://api.dubupay.com/api/v1/products?status=active&page=1&limit=20" \
  -H "X-Api-Key: dubu_sk_live_YOUR_API_KEY"

Get a product

GET /products/:id

Retrieve a single product by its UUID.

Path parameters

string

required

UUID of the product.

Example

curl https://api.dubupay.com/api/v1/products/prod_uuid_here \
  -H "X-Api-Key: dubu_sk_live_YOUR_API_KEY"

Update a product

PATCH /products/:id

Update one or more fields on an existing product. Only the fields you include in the request body are modified.

Path parameters

string

required

UUID of the product to update.

Request body

All fields are optional. You can update status to archived to retire a product without deleting it.

string

New product name.

string

New description. Pass null to clear it.

string

physical, digital, or service.

string

active, inactive, or archived.

number

New unit price.

string

NGN or USD.

number

Updated stock count. Pass null for unlimited.

Example

curl -X PATCH https://api.dubupay.com/api/v1/products/prod_uuid_here \
  -H "X-Api-Key: dubu_sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "inactive"}'

Delete a product

DELETE /products/:id

Permanently deletes a product. This action cannot be undone. Consider setting status to archived instead if you want to retain historical data.

Path parameters

string

required

UUID of the product to delete.

Example

curl -X DELETE https://api.dubupay.com/api/v1/products/prod_uuid_here \
  -H "X-Api-Key: dubu_sk_live_YOUR_API_KEY"

Returns 200 OK on success.

Overview

Auth

Payments

Trading

Commerce

Webhooks

Products API — create a product catalog

Product object

Create a product

Request body

Example

List products

Query parameters

Example

Get a product

Path parameters

Example

Update a product

Path parameters

Request body

Example

Delete a product

Path parameters

Example

​Product object

​Create a product

​Request body

​Example

​List products

​Query parameters

​Example

​Get a product

​Path parameters

​Example

​Update a product

​Path parameters

​Request body

​Example

​Delete a product

​Path parameters

​Example

Product object

Create a product

Request body

Example

List products

Query parameters

Example

Get a product

Path parameters

Example

Update a product

Path parameters

Request body

Example

Delete a product

Path parameters

Example