API Reference

Product object

A product is a service that you create to offer to your customers. This can be used for a one-time purchases (Single Payment) or for subscribing to it and generating a recurring purchases (Subscription).

{
    "product": {
        "name": "Boxing classes",
        "description": "First semester 2022",
        "value": 40000,
        "external_id": "001"
    }
}

Attributes

The attributes available for a Product object are:

NameTypeDescriptionRequired
idstringProduct unique identifier.false
namestringName of the Product you want to create.true
descriptionstringA description for the Product.false
valuenumberThe value of the Product.true
currencystringCurrency value for Product payments. The following values ​​are available:
- CLP (default)
- UF
false
imagefileAn image for the Product you want to create.false
statusstringThe status of the Product. It can be "active" (default) or "inactive".false
external_idstringAn external id to identify the Product.false