Skip to main content
POST
Grant samples

Authorizations

Authorization
string
header
required

Your API key goes here

Path Parameters

storeId
string<uuid>
required
resellerId
string<uuid>
required

Body

application/json

Grants a reseller free units so they can prove their integration works before funding a balance.

quantity
integer<int32>
required

How many free units to grant.

Required range: 1 <= x <= 1000
variantId
string<uuid> | null

The variant the samples are for. Null means any variant in the catalogue.

expiresAt
string<date-time> | null

When the grant stops being usable. Null means it does not expire.

Response

The object was successfully created.

Represents a default generic response for API endpoints.

success
boolean
required

Indicates whether the operation or response was successful.

message
string | null

A descriptive message providing additional context or information about the response.

code
string | null

The error code (if there was an error) to use when referencing the error

data
any | null

Represents the data associated with a response.

Last modified on August 22, 2026