Pricing

Download Spec

List Pricings For Product
get /products/{prod_id}/pricing

Returns specified pricing for a Providers product.

page

integer

Default
0

size

integer

Default
50

Response

ExamplesSchema

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
}

Create Pricing For Tpp Product
post /products/{prod_id}/pricing

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

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

ExamplesSchema

Successful Response

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

Get Pricing For Tpp Product
get /pricing/{price_id}

Get list of pricings for a Providers product.

price_id

string

required

Response

ExamplesSchema

Successful Response

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

Update Pricing
post /pricing/{price_id}

Updates Provider product pricing.

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

ExamplesSchema

Successful Response

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

Delete Pricing
delete /pricing/{price_id}

Deletes Provider product pricing.

price_id

string

required

Response

ExamplesSchema

Successful Response

Empty response

Was this page helpful?