For archived content, access the previous documentation here or the previous API reference here.

Get Product by ID

Prev Next
Get
/bill-payments/v1/product/{id}

Gets a specific product by its ID

Security
HTTP
Type Basic
Path parameters
id
stringRequired

Product ID

ExamplePLN_PREPAID_50K
Responses
200

Successful response

Expand All
object
type
string

Type of object, always "product"

Valid values[ "product" ]
id
string

Unique product identifier

properties
object
product_name
string

Display name of the product

category
string

Product category

Valid values[ "ELECTRICITY" ]
biller
string

Name of the biller/provider

country
string

Country code in ISO 3166-1 alpha-2 format

currency
string

Currency code in ISO 4217 format

requires_inquiry
boolean

Whether product requires inquiry before purchase

availability_status
string

Product availability status

Valid values[ "AVAILABLE", "TEMPORARILY_UNAVAILABLE", "DISCONTINUED" ]
admin_amount
number

Administrative fee amount

base_amount
number

Base product amount (0 for postpaid products)

total_amount
number

Total amount including admin fee

revenue_share_amount
number

Merchant revenue share amount

locale
object

Localized product names

en
string

Product name in English

id
string

Product name in Indonesian

404

The provided id does not exist. Please review the id and try again

object
error_code
string
Valid values[ "RATE_LIMIT_EXCEEDED" ]
message
string
errors
Array
OneOf
string
string
object
object