Products support three pricing types:
one_time for single purchases, subscription for recurring payments, and variable for customer-chosen amounts.The Product object
string
Unique identifier for the product (e.g.,
prod_abc123).string
Product name displayed to customers.
string | null
Price in the token’s smallest unit. Null for
variable product types.string
Contract address of the token for pricing.
number
Chain ID for the pricing token.
string | null
Product description.
string | null
Product image URL.
string
Default wallet address that receives payments for this product.
string
Pricing type:
one_time, subscription, or variable.object | null
Arbitrary key-value pairs for your own use. Not displayed to customers.
object | null
Custom form fields to collect during checkout. Same structure as Payment Links form_schema.
array | null
Shipping options for physical goods. Same structure as Payment Links shipping_options.
boolean
Whether the product is active. Inactive products cannot be used in new payment links.
string
ISO 8601 creation timestamp.
string
ISO 8601 last update timestamp.
List products
Retrieve a paginated list of your products.number
default:1
Page number for pagination.
number
default:20
Number of results per page (max 100).
boolean
Filter by active status. Omit to return all products.
- Response
Create a product
string
required
Product name.
string
required
Contract address of the token for pricing.
number
required
Chain ID for the pricing token.
string
required
Default wallet address that receives payments.
string
required
Pricing type. One of:
one_time, subscription, variable.string
Price in the token’s smallest unit. Required for
one_time and subscription types.string
Product description.
string
Product image URL.
object
Arbitrary key-value pairs (e.g.,
{"sku": "PRO-001"}). Up to 50 keys, 500 character values.object
Custom form fields to collect during checkout.
array
Shipping options for physical goods.
- Response
Retrieve a product
string
required
The product ID (e.g.,
prod_abc123).- Response
Returns the full Product object.
Update a product
Update an existing product. Only the fields you include in the request body will be updated.string
required
The product ID.
boolean
Set to
false to deactivate the product.- Response
Returns the updated Product object.
Delete a product
Soft-delete a product. The product will be marked as inactive and will no longer appear in list results by default. Existing payment links using this product will continue to function.string
required
The product ID.
- Response
Generate a payment link from a product
Automatically create a payment link pre-configured with the product’s settings. This is a convenience method that creates a new payment link using the product’sname, amount, token_address, chain_id, recipient_address, description, image_url, form_schema, and shipping_options.
string
required
The product ID.
string
Override the payment link name. Defaults to the product name.
string
URL to redirect customers after payment.
number
Maximum number of uses for the generated link.
string
ISO 8601 expiration timestamp for the generated link.
- Response
Returns a new Payment Link object with
product_id set to the source product.
HypeDuel