Environment:

List Pricings For Product

get /products/{prod_id}/pricing

Returns specified pricing for a Providers product.

Authentication

API Key ApiKey

prod_id

string

required

page

integer

Default
0

size

integer

Default
50

Responses

Response: application/json

items

array[object (TppProductPrice)]

required

TppProductPrice

object (TppProductPrice)

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

page

integer

required

size

int

required

total

integer

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create Pricing For Tpp Product

post /products/{prod_id}/pricing

Create pricing for a Providers product. Products can have multiple pricing options.

Authentication

API Key ApiKey

prod_id

string

required

application/json

amount

int

required

currency

string

required

description

string

meta

object (meta)

name

string

required

recurring_meta

object (recurring_meta)

type

An enumeration.

Responses

Response: application/json

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Get Pricing For Tpp Product

get /pricing/{price_id}

Get list of pricings for a Providers product.

Authentication

API Key ApiKey

price_id

string

required

Responses

Response: application/json

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Update Pricing

post /pricing/{price_id}

Updates Provider product pricing.

Authentication

API Key ApiKey

price_id

string

required

application/json

amount

int

required

currency

string

required

description

string

meta

object (meta)

name

string

required

recurring_meta

object (recurring_meta)

type

An enumeration.

Responses

Response: application/json

amount

int

required

currency

string

required

description

string

id

string

required

meta

object (meta)

name

string

required

prod_id

string

required

recurring_meta

object (recurring_meta)

tpp_id

string

required

type

An enumeration.

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Delete Pricing

delete /pricing/{price_id}

Deletes Provider product pricing.

Authentication

API Key ApiKey

price_id

string

required

Responses

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?