Pricing

List Pricings For Product

get /products/{prod_id}/pricing

Returns specified pricing for a Providers product.

API Key ApiKey

X-API-Key found in header

prod_id

string

required

page

integer

Default: 0

size

integer

Default: 50

Response

Examples Schema

Successful Response

{
  "items": [
    {
      "name": "string",
      "currency": "string",
      "amount": 123,
      "description": "string",
      "meta": {},
      "type": null,
      "recurring_meta": {},
      "id": "string",
      "tpp_id": "string",
      "prod_id": "string"
    }
  ],
  "total": null,
  "page": null,
  "size": 123
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

items

array[object (TppProductPrice)]

required

TppProductPrice

object (TppProductPrice)

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

id

string

required

tpp_id

string

required

prod_id

string

required

total

integer

required

page

integer

required

size

int

required

No schema

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.

API Key ApiKey

X-API-Key found in header

prod_id

string

required

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

Request

{
  "name": "string",
  "currency": "string",
  "amount": 123,
  "description": "string",
  "meta": {},
  "type": null,
  "recurring_meta": {}
}

Response

Examples Schema

Successful Response

{
  "name": "string",
  "currency": "string",
  "amount": 123,
  "description": "string",
  "meta": {},
  "type": null,
  "recurring_meta": {},
  "id": "string",
  "tpp_id": "string",
  "prod_id": "string"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

id

string

required

tpp_id

string

required

prod_id

string

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get Pricing For Tpp Product

get /pricing/{price_id}

Get list of pricings for a Providers product.

API Key ApiKey

X-API-Key found in header

price_id

string

required

Response

Examples Schema

Successful Response

{
  "name": "string",
  "currency": "string",
  "amount": 123,
  "description": "string",
  "meta": {},
  "type": null,
  "recurring_meta": {},
  "id": "string",
  "tpp_id": "string",
  "prod_id": "string"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

id

string

required

tpp_id

string

required

prod_id

string

required

No schema

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.

API Key ApiKey

X-API-Key found in header

price_id

string

required

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

Request

{
  "name": "string",
  "currency": "string",
  "amount": 123,
  "description": "string",
  "meta": {},
  "type": null,
  "recurring_meta": {}
}

Response

Examples Schema

Successful Response

{
  "name": "string",
  "currency": "string",
  "amount": 123,
  "description": "string",
  "meta": {},
  "type": null,
  "recurring_meta": {},
  "id": "string",
  "tpp_id": "string",
  "prod_id": "string"
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

name

string

required

currency

string

required

amount

int

required

description

string

meta

object (meta)

type

An enumeration.

recurring_meta

object (recurring_meta)

id

string

required

tpp_id

string

required

prod_id

string

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Delete Pricing

delete /pricing/{price_id}

Deletes Provider product pricing.

API Key ApiKey

X-API-Key found in header

price_id

string

required

Response

Examples Schema

Successful Response

Empty response

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required