Skip to main content

ProductWithPrice

price objectrequired
activebooleanrequired
billingIntervalstringnullable
commodityCodestringnullable
createdAtstring<date-time>nullable
currencystringrequired
idstringrequired
intervalCountinteger<int32>required
locationIdstringnullable
merchantIdstringrequired
metadata objectrequired
property name*string
organizationIdstringnullable
productIdstringrequired
taxBehaviorTaxBehaviorrequired

Possible values: [EXCLUSIVE, INCLUSIVE]

typePriceTyperequired

Possible values: [ONE_TIME, RECURRING]

unitAmountinteger<int64>required
unitOfMeasurestringnullable
product objectrequired
activebooleanrequired
categoryIdstringnullable
createdAtstring<date-time>nullable
defaultPriceIdstringnullable
descriptionstringnullable
externalIdstringnullable
idstringrequired
imageUrlstringnullable
itemKindProductItemKind

Possible values: [PRODUCT, SERVICE]

lastMutationIdstringnullable
locationIdstringrequired
merchantIdstringrequired
metadata objectrequired
property name*string
namestringrequired
organizationIdstringnullable
syncVersioninteger<int64>required
taxRateBpsinteger<int32>nullable
updatedAtstring<date-time>nullable
ProductWithPrice
{
"price": {
"active": true,
"billingInterval": "string",
"commodityCode": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"currency": "string",
"id": "string",
"intervalCount": 0,
"locationId": "string",
"merchantId": "string",
"metadata": {},
"organizationId": "string",
"productId": "string",
"taxBehavior": "EXCLUSIVE",
"type": "ONE_TIME",
"unitAmount": 0,
"unitOfMeasure": "string"
},
"product": {
"active": true,
"categoryId": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"defaultPriceId": "string",
"description": "string",
"externalId": "string",
"id": "string",
"imageUrl": "string",
"itemKind": "PRODUCT",
"lastMutationId": "string",
"locationId": "string",
"merchantId": "string",
"metadata": {},
"name": "string",
"organizationId": "string",
"syncVersion": 0,
"taxRateBps": 0,
"updatedAt": "2024-07-29T15:51:28.071Z"
}
}