Products
Get product details
Retrieve a single product’s details
GET
/
product
/
{product_code}
Copy
Ask AI
curl --request GET \
--url https://playground.runa.io/v2/product/{product_code} \
--header 'X-Api-Key: <api-key>'
Copy
Ask AI
{
"approval_state": "REQUIRES_CUSTOMER_ACTION",
"categories": [
"<string>"
],
"code": "<string>",
"countries_redeemable_in": [
"<string>"
],
"currency": "<string>",
"customer_service": {
"phone_number": "<string>",
"website_url": "<string>"
},
"discount_multiplier": "<string>",
"name": "<string>",
"state": "LIVE",
"is_orderable": true,
"payout_type": "<string>",
"availability": "stocked",
"gift_card": {
"assets": {
"card_image_url": "<string>",
"icon_image_url": "<string>",
"primary_color": "<string>"
},
"balance_check_url": "<string>",
"content_resources": {
"description_markdown_url": "<string>",
"disclaimer_markdown_url": "<string>",
"refund_policy_markdown_url": "<string>",
"reissuance_policy_markdown_url": "<string>",
"terms_buyer_markdown_url": "<string>",
"terms_consumer_markdown_url": "<string>",
"redemption_instructions_markdown_url": "<string>",
"locale": "<string>"
},
"expiry": {
"date_policy": "<string>",
"in_months": 123,
"type": "from-last-use"
},
"redeemable_at": "all",
"website_url": "<string>",
"barcode_format": "code-128",
"e_code_usage_type": "undefined",
"denominations": {
"available_list": [
"<string>"
],
"maximum_value": "<string>",
"minimum_value": "<string>",
"type": "open"
}
},
"subscription": {
"assets": {
"card_image_url": "<string>",
"icon_image_url": "<string>",
"primary_color": "<string>"
},
"balance_check_url": "<string>",
"content_resources": {
"description_markdown_url": "<string>",
"disclaimer_markdown_url": "<string>",
"refund_policy_markdown_url": "<string>",
"reissuance_policy_markdown_url": "<string>",
"terms_buyer_markdown_url": "<string>",
"terms_consumer_markdown_url": "<string>",
"redemption_instructions_markdown_url": "<string>",
"locale": "<string>"
},
"expiry": {
"date_policy": "<string>",
"in_months": 123,
"type": "from-last-use"
},
"redeemable_at": "all",
"website_url": "<string>",
"barcode_format": "code-128",
"e_code_usage_type": "undefined",
"subscription_plans": [
{
"length_unit": "DAYS",
"length": 123,
"name": "<string>",
"price": "<string>",
"subscription_plan_code": "<string>"
}
]
},
"payment": {
"assets": {
"icon_image_url": "<string>",
"primary_color": "<string>"
},
"denominations": {
"maximum_value": "<string>",
"minimum_value": "<string>"
},
"content_resources": {
"description_markdown_url": "<string>",
"disclaimer_markdown_url": "<string>",
"refund_policy_markdown_url": "<string>",
"reissuance_policy_markdown_url": "<string>",
"terms_buyer_markdown_url": "<string>",
"terms_consumer_markdown_url": "<string>",
"redemption_instructions_markdown_url": "<string>",
"locale": "<string>"
}
}
}
Authorizations
Headers
The dated version of the API, if not specified a default is used. See API versioning for more information.
Path Parameters
The code of the product.
Query Parameters
Defines the format for product content resources. It accepts 'url' (default), 'md', or 'html' to return URLs, raw Markdown, or HTML content, respectively.
Available options:
url
, md
, html
Response
200
application/json
OK
Base schema for all product types, containing common fields.
Was this page helpful?
Copy
Ask AI
curl --request GET \
--url https://playground.runa.io/v2/product/{product_code} \
--header 'X-Api-Key: <api-key>'
Copy
Ask AI
{
"approval_state": "REQUIRES_CUSTOMER_ACTION",
"categories": [
"<string>"
],
"code": "<string>",
"countries_redeemable_in": [
"<string>"
],
"currency": "<string>",
"customer_service": {
"phone_number": "<string>",
"website_url": "<string>"
},
"discount_multiplier": "<string>",
"name": "<string>",
"state": "LIVE",
"is_orderable": true,
"payout_type": "<string>",
"availability": "stocked",
"gift_card": {
"assets": {
"card_image_url": "<string>",
"icon_image_url": "<string>",
"primary_color": "<string>"
},
"balance_check_url": "<string>",
"content_resources": {
"description_markdown_url": "<string>",
"disclaimer_markdown_url": "<string>",
"refund_policy_markdown_url": "<string>",
"reissuance_policy_markdown_url": "<string>",
"terms_buyer_markdown_url": "<string>",
"terms_consumer_markdown_url": "<string>",
"redemption_instructions_markdown_url": "<string>",
"locale": "<string>"
},
"expiry": {
"date_policy": "<string>",
"in_months": 123,
"type": "from-last-use"
},
"redeemable_at": "all",
"website_url": "<string>",
"barcode_format": "code-128",
"e_code_usage_type": "undefined",
"denominations": {
"available_list": [
"<string>"
],
"maximum_value": "<string>",
"minimum_value": "<string>",
"type": "open"
}
},
"subscription": {
"assets": {
"card_image_url": "<string>",
"icon_image_url": "<string>",
"primary_color": "<string>"
},
"balance_check_url": "<string>",
"content_resources": {
"description_markdown_url": "<string>",
"disclaimer_markdown_url": "<string>",
"refund_policy_markdown_url": "<string>",
"reissuance_policy_markdown_url": "<string>",
"terms_buyer_markdown_url": "<string>",
"terms_consumer_markdown_url": "<string>",
"redemption_instructions_markdown_url": "<string>",
"locale": "<string>"
},
"expiry": {
"date_policy": "<string>",
"in_months": 123,
"type": "from-last-use"
},
"redeemable_at": "all",
"website_url": "<string>",
"barcode_format": "code-128",
"e_code_usage_type": "undefined",
"subscription_plans": [
{
"length_unit": "DAYS",
"length": 123,
"name": "<string>",
"price": "<string>",
"subscription_plan_code": "<string>"
}
]
},
"payment": {
"assets": {
"icon_image_url": "<string>",
"primary_color": "<string>"
},
"denominations": {
"maximum_value": "<string>",
"minimum_value": "<string>"
},
"content_resources": {
"description_markdown_url": "<string>",
"disclaimer_markdown_url": "<string>",
"refund_policy_markdown_url": "<string>",
"reissuance_policy_markdown_url": "<string>",
"terms_buyer_markdown_url": "<string>",
"terms_consumer_markdown_url": "<string>",
"redemption_instructions_markdown_url": "<string>",
"locale": "<string>"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.