Sign in

v1

latestOpenAPI 3.1.02026-07-26490301.4 KB
Product

Create product (SKU)

post/sku

Headers

X-Request-IDstring

Unique ID of request

Request body

OR

Example request

{
  "siteId": "983759353",
  "title": "Annual subscription",
  "externalId": "7f9s7f9sfs9",
  "price": [
    {
      "offset": "5d",
      "amount": 9.99,
      "currency": "USD"
    }
  ]
}

Response

Created

namestring

SKU name that you added when creating SKU

siteIdstring

Gateway site ID (created on the Merchant portal)

externalIdstring

Merchant site ID

titlestring

Product name displayed on the payment page (3–128 characters)

activeboolean

Indicates whether the SKU is active

editableboolean

Indicates whether the SKU can be edited. "False" when the SKU has existing sales (successful, shipped, or test transactions)

type'one-time' | 'subscription'
typedescription
one-timesingle payment
subscriptionrecurrent payments
currencystring ISO3

Currency of operation in ISO3 format

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "name": "TEST_EN",
  "siteId": "983759353",
  "externalId": "14253ms92m0as",
  "price": 9.99,
  "currency": "USD",
  "createdAt": "2020-04-17 13:43:02",
  "updatedAt": "2020-11-17 13:43:02"
}