Products

GET/v2/products

Get products

Get a list of all the products from your organization.

Optional Query Parameters

orderstring

searchstring

pagestring

takejson

Response

      {
        "data": [
            {
                "id": "xxxxxx-9cce-xx-a9e1-380439922192",
                "name": "UX/UI Advanced Workshop",
                "description": "8h workshop content with final project.",
                "metadata": {
                    "SKU": "1qa2ws3ed"
                },
                "createdAt": "2023-12-19T14:25:28.769Z",
                "itemFamilyId": null,
                "archive": false,
                "assets": null,
                "type": "product"
            },
            // more products...
        ],
        "meta": {
            "page": 1,
            "take": 35,
            "itemCount": 3,
            "pageCount": 1,
            "hasPreviousPage": false,
            "hasNextPage": false
        }
    }

GET/v2/products/{productId}

Get product by id

Get the properties of a specific product with its ID, along with its prices and currencies.

Required Path Parameters

productIdstringrequired

Response

  {
     {
              "id": "b3595622-90e7-49d4-8715-2cd898aaa8dc",
              "name": "test",
              "description": "example description.",
              "metadata": {},
              "prices": [
                    {
                      "id": "xxxxxxxb-09f6-4e90-b7e0-adxxxxx9056b3",
                      "createdAt": "2024-02-29T04:13:28.585Z",
                      "gateway": {
                          "id": "xxxxxxxx5-630a-4438-b7d9-9bc87eb20f94",
                          "type": "rebill_gateway",
                          "country": "I",
                          "description": "Rebill Gateway | Crossborder | Chile | ALL",
                          "status": "ACCEPTED",
                          "publicKey": "8lynHfD3elgz7AD1MSBL0G_I56ONV7HQ",
                          "recurring": false,
                          "crossborder": true
                      },
                      "frequency": {
                          "type": "days",
                          "quantity": 1
                      },
                      "repetitions": 1,
                      "description": null,
                      "currency": "ARS",
                      "archive": false,
                      "priceSetting": {
                          "id": "xxxxxxx-d786-4ebd-ae69-d2a7d3b5820b",
                          "documentRequired": true,
                          "phoneRequired": true,
                          "billingAddressRequired": true,
                          "showImage": true,
                          "redirectUrl": null,
                          "paymentMethods": [
                              "REBILL_PAGO_FACIL",
                              "REBILL_TRANSFERENCIA_3_0",
                              "CARD"
                          ],
                          "expirationDate": null,
                          "allowDiscountCodes": true
                      },
                      "parent": null,
                      "itemId": "b3595622-90e7-49d4-8715-2cd898aaa8dc",
                      "amount": "1200",
                      "type": "fixed",
                      "debitDay": null,
                      "debitType": null,
                      "isExpired": null
                  }
                    ],
                    "createdAt": "2024-02-29T04:13:28.562Z",
                    "itemFamilyId": null,
                    "archive": false
              }
}

POST/v2/products

Create a product

Create a new product.

Required Parameters

namestringrequired

currenciesarray of objectsrequired

Optional Parameters

descriptionstring

metadataobject

Response

  {
    "product": {
        "id": "xxxxxxx-5474-xx-xx-d789ed22977e",
        "name": "AI advanced webinar",
        "description": null,
        "metadata": null,
        "createdAt": "2024-04-11T13:58:18.287Z"
    },
    "paymentLinkUrl": "https://pay.rebill.dev/your-organization/xxxxxxx-dca7-xx-9b06-2fcd31f9c3ea",
    "currencies": [
        {
            "createdAt": "2024-04-11T13:58:18.532Z",
            "gateway": {
                "id": "xxxxx-630a-xx-b7d9-9bc87eb20f94",
                "type": "rebill_gateway",
                "description": "Rebill Gateway | Crossborder | Chile | ALL"
            },
            "description": null,
            "currency": "ARS",
            "archive": false,
            "productId": "xxxx-5474-4850-xxx-d789ed22977e",
            "amount": "1000"
        },
        {
            "createdAt": "2024-04-11T13:58:18.556Z",
            "gateway": {
                "id": "xxxxxx-630a-xx-b7d9-9bc87eb20f94",
                "type": "rebill_gateway",
                "description": "Rebill Gateway | Crossborder | Chile | ALL"
            },
            "description": null,
            "currency": "COP",
            "archive": false,
            "productId": "xxxxx-5474-xx-98ba-d789ed22977e",
            "amount": "980"
        }
    ]
}

PUT/v2/products/{productId}

Update a product

Update the properties of a product along with the prices defined for different currencies, with the product and currency amount IDs.

Required Path Parameters

idstringrequired

Required Body Parameters

namestringrequired

Optional Parameters

descriptionstring

currenciesarray of objects

metadataobject

archiveboolean

Response

    {
      // responds success with status 200
  }