Products: Creates a new invoice product.

POST /api/invoicing/products deprecated

Requires: Invoicing.Products, Invoicing.Products.Create, merchant scope.

Requires API key scope: admin (Administration)

A `productCode` another of the biller's products already holds (compared case-insensitively) is refused as a validation error on that field, so no two products of one biller share a SKU.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

Example request

Each example below is one request, shown in every language. Choose an example and a language, then replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a InvoiceProductCreateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

Service billed by the month

Adds a service to the merchant's catalog at 450.00 a month, marked not taxable. An invoice line built from a product stores its own description and price, so a later change to the product never alters an existing invoice. The product code is optional; when sent it must be unique within the merchant, compared without regard to case. Replace billerId with your merchant's id.

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/products" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/products' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.invoiceProductCreate({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/products', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "name": "Website maintenance",
    "description": "Monthly updates, backups and uptime monitoring",
    "productCode": "SVC-MAINT",
    "defaultPrice": 450,
    "isActive": true,
    "currency": "USD",
    "productType": "Service",
    "isTaxable": false,
    "unitOfMeasure": "month"
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var body = JsonSerializer.Deserialize<InvoiceProductCreateDto>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Website maintenance",
      "description": "Monthly updates, backups and uptime monitoring",
      "productCode": "SVC-MAINT",
      "defaultPrice": 450,
      "isActive": true,
      "currency": "USD",
      "productType": "Service",
      "isTaxable": false,
      "unitOfMeasure": "month"
    }
    """);

var result = await api.InvoiceProductCreateAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/invoicing/products");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Website maintenance",
      "description": "Monthly updates, backups and uptime monitoring",
      "productCode": "SVC-MAINT",
      "defaultPrice": 450,
      "isActive": true,
      "currency": "USD",
      "productType": "Service",
      "isTaxable": false,
      "unitOfMeasure": "month"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.InvoicingApi(client)
    body = winkpg_api.InvoiceProductCreateDto.from_dict({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Website maintenance",
      "description": "Monthly updates, backups and uptime monitoring",
      "productCode": "SVC-MAINT",
      "defaultPrice": 450,
      "isActive": True,
      "currency": "USD",
      "productType": "Service",
      "isTaxable": False,
      "unitOfMeasure": "month"
    })
    result = api.invoice_product_create(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": True,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": False,
  "unitOfMeasure": "month"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/invoicing/products",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Shipped product with a default tax rate

Adds a physical product at 24.00 each that ships in a 5 by 4 by 4 inch parcel weighing 0.75 pounds. defaultTaxRateId must name one of the merchant's own active tax rates (a synthetic id here); it is the rate the invoice editor applies when the product is picked. A weight needs its unit, and length, width and height are sent together with their unit or not at all. Replace billerId with your merchant's id.

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/products" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/products' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.invoiceProductCreate({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/products', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "name": "Ceramic travel mug",
    "description": "12 oz insulated mug with a sliding lid",
    "productCode": "MUG-12OZ",
    "defaultPrice": 24,
    "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
    "isActive": true,
    "currency": "USD",
    "productType": "Physical",
    "isTaxable": true,
    "unitOfMeasure": "each",
    "requiresShipping": true,
    "weight": 0.75,
    "weightUnit": "Pound",
    "length": 5,
    "width": 4,
    "height": 4,
    "dimensionUnit": "Inch"
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var body = JsonSerializer.Deserialize<InvoiceProductCreateDto>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Ceramic travel mug",
      "description": "12 oz insulated mug with a sliding lid",
      "productCode": "MUG-12OZ",
      "defaultPrice": 24,
      "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
      "isActive": true,
      "currency": "USD",
      "productType": "Physical",
      "isTaxable": true,
      "unitOfMeasure": "each",
      "requiresShipping": true,
      "weight": 0.75,
      "weightUnit": "Pound",
      "length": 5,
      "width": 4,
      "height": 4,
      "dimensionUnit": "Inch"
    }
    """);

var result = await api.InvoiceProductCreateAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/invoicing/products");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Ceramic travel mug",
      "description": "12 oz insulated mug with a sliding lid",
      "productCode": "MUG-12OZ",
      "defaultPrice": 24,
      "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
      "isActive": true,
      "currency": "USD",
      "productType": "Physical",
      "isTaxable": true,
      "unitOfMeasure": "each",
      "requiresShipping": true,
      "weight": 0.75,
      "weightUnit": "Pound",
      "length": 5,
      "width": 4,
      "height": 4,
      "dimensionUnit": "Inch"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.InvoicingApi(client)
    body = winkpg_api.InvoiceProductCreateDto.from_dict({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Ceramic travel mug",
      "description": "12 oz insulated mug with a sliding lid",
      "productCode": "MUG-12OZ",
      "defaultPrice": 24,
      "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
      "isActive": True,
      "currency": "USD",
      "productType": "Physical",
      "isTaxable": True,
      "unitOfMeasure": "each",
      "requiresShipping": True,
      "weight": 0.75,
      "weightUnit": "Pound",
      "length": 5,
      "width": 4,
      "height": 4,
      "dimensionUnit": "Inch"
    })
    result = api.invoice_product_create(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": True,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": True,
  "unitOfMeasure": "each",
  "requiresShipping": True,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/invoicing/products",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

name required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

Conditional: When Description is not empty. Max length: 1000. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productCode required

string

Optional SKU or product code. Stored trimmed, with its letter case kept. Unique within the biller, compared case-insensitively: a code another of the biller's products already holds is rejected with a validation error naming this field. Leave it empty (or send whitespace, which is stored as no code) for a product without a code; any number of those may exist. Conditional: When ProductCode is not empty. Max length: 50. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

imageBlobName required

string

Bare blob filename of the product image, as returned by the hosted-page image upload endpoint (`POST /api/hostedpaymentpages/images/upload`). Omit or send null to leave the product without an image; an empty string also clears it. Never a URL, a path, or inline image data. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

defaultPrice required

number (double)

min 0

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxCategoryId required

string (uuid)

Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted and stored as sent, and never applied to a line item. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

defaultTaxRateId required

string (uuid)

Optional. The id of one of the biller's active tax rates, applied to an invoice line when this product is picked. Must belong to the same biller as the product; a rate that does not exist, belongs to another biller, or has been deactivated is rejected with a validation error naming this field. Omit or send null for no default. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isActive required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

sortOrder required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

currency required

string

Conditional: When Currency is not empty. Max length: 3. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

pricingModel required

PricingModel PricingModel

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Fixed`	A single fixed price per unit.
`Tiered`	Price varies by quantity tier (e.g., 1-10 = $5, 11-50 = $4).
`UsageBased`	Price determined by metered usage (e.g., per GB, per API call).
`Custom`	Custom pricing negotiated per deal or contract.

allowCustomPrice required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productType required

ProductType ProductType

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Physical`	Physical goods that are shipped or delivered.
`Service`	Professional or managed services billed by time or engagement.
`Digital`	Digital goods such as software licenses, downloads, or subscriptions.
`Fee`	Flat fees such as setup charges, late fees, or surcharges.
`Discount`	Discount line items that reduce the invoice total.

isTaxable required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxCode required

string

Conditional: When TaxCode is not empty. Max length: 50. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitOfMeasure required

string

Conditional: When UnitOfMeasure is not empty. Max length: 50. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

commodityCode required

string

Commodity code snapshotted onto an invoice line when this product is applied, and sent as enhanced (Level 3) card data. At most 25 characters. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

allowFractionalQuantity required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

minimumQuantity required

number (double)

Conditional: When MinimumQuantity is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

maximumQuantity required

number (double)

Conditional: When MaximumQuantity is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

requiresShipping required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

weight required

number (double)

nullablegreater than 0max 999999.9999

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

weightUnit required

ShippingWeightUnit ShippingWeightUnit

Required: When Weight is not null. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Gram`	Grams.
`Kilogram`	Kilograms.
`Ounce`	Ounces (avoirdupois).
`Pound`	Pounds (avoirdupois).

length required

number (double)

nullablegreater than 0max 99999.9999

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

width required

number (double)

nullablegreater than 0max 99999.9999

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

height required

number (double)

nullablegreater than 0max 99999.9999

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dimensionUnit required

ShippingDimensionUnit ShippingDimensionUnit

Required: When Length is not null or Width is not null or Height is not null. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Centimeter`	Centimetres.
`Inch`	Inches.

revenueAccount required

string

Conditional: When RevenueAccount is not empty. Max length: 100. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deferredRevenue required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recognitionRuleId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

tags required

array of EntityTag array of EntityTag

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each EntityTag:

Field Type Description

name required

string

nullablemin length 0max length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

value required

string

nullablemin length 0max length 150

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

billerId required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerType required

InvoicePartyType InvoicePartyType

Identifies the type of entity acting as the biller or recipient on an invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`GatewayOwner`	Platform-level gateway owner.
`Reseller`	Reseller entity.
`Merchant`	Merchant entity.
`Customer`	End customer.

This request body has no documented fields.

Responses

200 OK

Body: InvoiceProductDto InvoiceProductDto Each item has these fields.

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

The date and time when this entity was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creatorId required

string (uuid)

The ID of the user who created this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModificationTime required

string (date-time)

The date and time when this entity was last modified. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModifierId required

string (uuid)

The ID of the user who last modified this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerId required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerType required

InvoicePartyType InvoicePartyType

Identifies the type of entity acting as the biller or recipient on an invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`GatewayOwner`	Platform-level gateway owner.
`Reseller`	Reseller entity.
`Merchant`	Merchant entity.
`Customer`	End customer.

name required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productCode required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

imageBlobName required

string

Bare blob filename of the product image in the hosted-page image container, or null when the product has no image. Rendered at `{cdn}/hosted-page-imgs/host/{name}`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

defaultPrice required

number (double)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxCategoryId required

string (uuid)

Superseded by `defaultTaxRateId`; retained for compatibility, not read. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

defaultTaxRateId required

string (uuid)

The biller's tax rate applied to an invoice line when this product is picked, or null when the product carries no default. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isActive required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

sortOrder required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

currency required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

pricingModel required

PricingModel PricingModel

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Fixed`	A single fixed price per unit.
`Tiered`	Price varies by quantity tier (e.g., 1-10 = $5, 11-50 = $4).
`UsageBased`	Price determined by metered usage (e.g., per GB, per API call).
`Custom`	Custom pricing negotiated per deal or contract.

allowCustomPrice required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productType required

ProductType ProductType

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Physical`	Physical goods that are shipped or delivered.
`Service`	Professional or managed services billed by time or engagement.
`Digital`	Digital goods such as software licenses, downloads, or subscriptions.
`Fee`	Flat fees such as setup charges, late fees, or surcharges.
`Discount`	Discount line items that reduce the invoice total.

isTaxable required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxCode required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitOfMeasure required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

commodityCode required

string

Default commodity code for enhanced (Level 3) card data. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

allowFractionalQuantity required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

minimumQuantity required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

maximumQuantity required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

requiresShipping required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

weight required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

weightUnit required

ShippingWeightUnit ShippingWeightUnit

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Gram`	Grams.
`Kilogram`	Kilograms.
`Ounce`	Ounces (avoirdupois).
`Pound`	Pounds (avoirdupois).

length required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

width required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

height required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dimensionUnit required

ShippingDimensionUnit ShippingDimensionUnit

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Centimeter`	Centimetres.
`Inch`	Inches.

revenueAccount required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deferredRevenue required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recognitionRuleId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

tags required

array of EntityTag array of EntityTag

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each EntityTag:

Field Type Description

name required

string

nullablemin length 0max length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

value required

string

nullablemin length 0max length 150

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

archivedAt required

string (date-time)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

400 The request is invalid, including a `productCode` already held by another product of the same biller.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take. The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Invoicing

The API reference isn't available right now

No such operation

This reference may be out of date

Products: Creates a new invoice product.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 The request is invalid, including a `productCode` already held by another product of the same biller.

404 Not Found

501 Not Implemented

500 Internal Server Error

Errors

Authentication