paddle/products

Types

PaddleProduct = object of PaddleBaseObject
  name*: string              ## The name of the product
  description*: string       ## Short description for this product
  image_url*: string         ## URL of the product image. Must be an HTTPS URL that is publicly accessible.
  tax_category*: PaddleTaxCategory
Represents a product entity with included entities

Procs

proc getProduct(client: PaddleClient; id: PaddleEntryID): Future[
    PaddleApiResponse[PaddleProduct]] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, TimeParseError,
    PaddleClientError], tags: [RootEffect, ReadIOEffect, TimeEffect],
                                        forbids: [].}
Retrieves a single product by its unique identifier.
proc getProducts(client: PaddleClient): Future[
    PaddleApiResponse[seq[PaddleProduct]]] {....stackTrace: false, raises: [
    Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError,
    IOError, ProtocolError, KeyError, OpenParserJsonError, TimeParseError,
    PaddleClientError], tags: [RootEffect, ReadIOEffect, TimeEffect],
    forbids: [].}
Retrieves a list of products.
proc postProduct(client: PaddleClient; name: string;
                 taxCategory = PaddleTaxCategory.standard;
                 description: Option[string] = none(string);
                 imageUrl: Option[string] = none(string);
                 customData: JsonNode = nil): Future[
    PaddleApiResponse[PaddleProduct]] {....stackTrace: false, raises: [Exception,
    ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError,
    ProtocolError, KeyError, OpenParserJsonError, TimeParseError,
    PaddleClientError], tags: [RootEffect, ReadIOEffect, TimeEffect],
                                        forbids: [].}

Creates a new product with the specified parameters.

Paddle does not upload product images to a CDN. For image_url, you should host images on an HTTPS server that's publicly accessible.

Tips: Use square images (1:1 ratio) for best results