Retrieve a product

get https://api.spherepay.co/v1/product/{id}

Retrieves a product object by id.

Response

`product` object.

Response body

object

string

required

Unique identifier for the product.

name

string

Name for the product, displayed to customers.

description

string

Description for the product, displayed to customers.

images

array of strings

List of image URLs for the product, displayed to customers.

images

meta

object

Key/value pairs (JSON) for extra info on the object. Useful for external use.

Has additional fields

network

string

The underlying blockchain or fiat network that the price is associated with. Defaults to sol (Solana).

localhost ethereum polygon optimism goerli sepolia mumbai optimism-goerli sol wire stripe

billingScheme

string

perUnit sets a fixed price per unit, defined by either unitAmountDecimal or unitAmount. tiered sets a variable price per unit, defined by the tiers and tierType fields.

perUnit tiered

taxBehavior

string

Whether the price is inclusive of tax. Defaults to exclusive.

inclusive exclusive unspecified

type

string

Whether the price is for one-time or recurring (subscription) payments. Defaults to one-time.

oneTime recurring

tierType

string

The pricing model used for tiered subscriptions. Either graduated or volume. Requires billingScheme to be set to tiered and is null by default.

graduated volume

tiers

array of objects

List of tiers, where each element represents a different pricing tier. Requires billingScheme to be set to tiered and is null by default.

tiers

object

flatAmount

string

flatAmountDecimal

number

unitAmount

string

unitAmountDecimal

number

upTo

object

Has additional fields

currency

string

required

The public key, or name, of the underlying token, or fiat currency, for the price. Mint address on Solana, token contract address on EVM, or a string currency code (e.g. usd).

unitAmount

string

The raw cost of the price, denominated in the specified currency. A non-negative integer in raw token decimals. For example, to charge 5 USDC, use 5_000_000 (5*10^6) since the the number of token decimals of USDC is 6. Mutually exclusive with unitAmountDecimal.

unitAmountDecimal

number

The decimal adjusted cost of the price, denominated in the specified currency. A non-negative integer in base-10. For example, to charge 5 USDC, use 5. Mutually exclusive with unitAmount.

recurring

object

required

updated

string

required

The last datetime the price was updated.

created

string

required

The datetime the price was created.

updated

string

required

The last datetime the product was updated.

created

string

required

The datetime the product was created.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.spherepay.co/v1/product/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A product object.

`product` object.