Catalog and rates

Lists products owned by an organization.

Query Parameters

pageSize?integer

Formatint32

pageToken?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/products"

{  "nextPageToken": "string",  "products": [    {      "createTime": "2019-08-24T14:15:22Z",      "displayName": "string",      "meter": "string",      "name": "string",      "presentationGroupKeys": [        "string"      ],      "pricingGroupKeys": [        "string"      ],      "tags": [        "string"      ],      "type": "PRODUCT_TYPE_UNSPECIFIED"    }  ]}

Creates a product that can appear as an invoice line item.

Query Parameters

productId*string

requestId?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Product is a sellable SKU and the basic unit of an invoice line.

displayName*string

meter?string

name?string

presentationGroupKeys?array<string>

pricingGroupKeys?array<string>

tags?array<string>

type*railzway.fare.catalog.v1.ProductType

ProductType identifies how a product contributes charges to an invoice.

Value in

"PRODUCT_TYPE_UNSPECIFIED"
"PRODUCT_TYPE_USAGE"
"PRODUCT_TYPE_SUBSCRIPTION"
"PRODUCT_TYPE_FIXED"
"PRODUCT_TYPE_COMPOSITE"

Response Body

`application/json`

curl -X POST "https://example.com/v1/products?productId=string" \  -H "Content-Type: application/json" \  -d '{    "displayName": "string",    "type": "PRODUCT_TYPE_UNSPECIFIED"  }'

{  "createTime": "2019-08-24T14:15:22Z",  "displayName": "string",  "meter": "string",  "name": "string",  "presentationGroupKeys": [    "string"  ],  "pricingGroupKeys": [    "string"  ],  "tags": [    "string"  ],  "type": "PRODUCT_TYPE_UNSPECIFIED"}

Gets a product by resource name.

Path Parameters

name*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/products/string"

{  "createTime": "2019-08-24T14:15:22Z",  "displayName": "string",  "meter": "string",  "name": "string",  "presentationGroupKeys": [    "string"  ],  "pricingGroupKeys": [    "string"  ],  "tags": [    "string"  ],  "type": "PRODUCT_TYPE_UNSPECIFIED"}

Lists rate cards owned by an organization.

Query Parameters

pageSize?integer

Formatint32

pageToken?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/rateCards"

{  "nextPageToken": "string",  "rateCards": [    {      "createTime": "2019-08-24T14:15:22Z",      "currencyCode": "string",      "displayName": "string",      "name": "string",      "rates": [        {          "dimensionValues": {            "property1": "string",            "property2": "string"          },          "effectivePeriod": {            "endTime": "2019-08-24T14:15:22Z",            "startTime": "2019-08-24T14:15:22Z"          },          "flat": {            "amount": {              "amount": {                "value": "string"              },              "currencyCode": "string"            }          },          "id": "string",          "package": {            "packagePrice": {              "amount": {                "value": "string"              },              "currencyCode": "string"            },            "packageSize": {              "value": "string"            }          },          "product": "string",          "tiered": {            "tiers": [              {                "endQuantity": {                  "value": "string"                },                "flatAmount": {                  "amount": {                    "value": "string"                  },                  "currencyCode": "string"                },                "startQuantity": {                  "value": "string"                },                "unitPrice": {                  "amount": {                    "value": "string"                  },                  "currencyCode": "string"                }              }            ]          },          "unit": {            "unitPrice": {              "amount": {                "value": "string"              },              "currencyCode": "string"            },            "unitSize": {              "value": "string"            }          }        }      ]    }  ]}

Creates a reusable price book for customer contracts.

Query Parameters

rateCardId*string

requestId?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

RateCard is a currency-specific collection of product rates.

currencyCode*string

displayName*string

name?string

Response Body

`application/json`

curl -X POST "https://example.com/v1/rateCards?rateCardId=string" \  -H "Content-Type: application/json" \  -d '{    "currencyCode": "string",    "displayName": "string"  }'

{  "createTime": "2019-08-24T14:15:22Z",  "currencyCode": "string",  "displayName": "string",  "name": "string",  "rates": [    {      "dimensionValues": {        "property1": "string",        "property2": "string"      },      "effectivePeriod": {        "endTime": "2019-08-24T14:15:22Z",        "startTime": "2019-08-24T14:15:22Z"      },      "flat": {        "amount": {          "amount": {            "value": "string"          },          "currencyCode": "string"        }      },      "id": "string",      "package": {        "packagePrice": {          "amount": {            "value": "string"          },          "currencyCode": "string"        },        "packageSize": {          "value": "string"        }      },      "product": "string",      "tiered": {        "tiers": [          {            "endQuantity": {              "value": "string"            },            "flatAmount": {              "amount": {                "value": "string"              },              "currencyCode": "string"            },            "startQuantity": {              "value": "string"            },            "unitPrice": {              "amount": {                "value": "string"              },              "currencyCode": "string"            }          }        ]      },      "unit": {        "unitPrice": {          "amount": {            "value": "string"          },          "currencyCode": "string"        },        "unitSize": {          "value": "string"        }      }    }  ]}

Gets a rate card by resource name.

Path Parameters

name*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/rateCards/string"

{  "createTime": "2019-08-24T14:15:22Z",  "currencyCode": "string",  "displayName": "string",  "name": "string",  "rates": [    {      "dimensionValues": {        "property1": "string",        "property2": "string"      },      "effectivePeriod": {        "endTime": "2019-08-24T14:15:22Z",        "startTime": "2019-08-24T14:15:22Z"      },      "flat": {        "amount": {          "amount": {            "value": "string"          },          "currencyCode": "string"        }      },      "id": "string",      "package": {        "packagePrice": {          "amount": {            "value": "string"          },          "currencyCode": "string"        },        "packageSize": {          "value": "string"        }      },      "product": "string",      "tiered": {        "tiers": [          {            "endQuantity": {              "value": "string"            },            "flatAmount": {              "amount": {                "value": "string"              },              "currencyCode": "string"            },            "startQuantity": {              "value": "string"            },            "unitPrice": {              "amount": {                "value": "string"              },              "currencyCode": "string"            }          }        ]      },      "unit": {        "unitPrice": {          "amount": {            "value": "string"          },          "currencyCode": "string"        },        "unitSize": {          "value": "string"        }      }    }  ]}

Adds an immutable, effective-dated rate to a rate card.

Path Parameters

parent*string

Query Parameters

requestId?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Rate assigns one pricing model to a product for a non-overlapping period.

dimensionValues?

effectivePeriod*

EffectivePeriod is a half-open validity interval: [start_time, end_time).

flat?

FlatRate charges a fixed amount independently of quantity.

package?

PackageRate charges by fixed-size packages of quantity.

product*string

tiered?

TieredRate applies ordered price tiers to a quantity.

unit?

UnitRate charges an exact price for each unit_size of quantity.

Response Body

`application/json`

curl -X POST "https://example.com/v1/rateCards/string/rates" \  -H "Content-Type: application/json" \  -d '{    "effectivePeriod": {      "startTime": "2019-08-24T14:15:22Z"    },    "product": "string"  }'

{  "dimensionValues": {    "property1": "string",    "property2": "string"  },  "effectivePeriod": {    "endTime": "2019-08-24T14:15:22Z",    "startTime": "2019-08-24T14:15:22Z"  },  "flat": {    "amount": {      "amount": {        "value": "string"      },      "currencyCode": "string"    }  },  "id": "string",  "package": {    "packagePrice": {      "amount": {        "value": "string"      },      "currencyCode": "string"    },    "packageSize": {      "value": "string"    }  },  "product": "string",  "tiered": {    "tiers": [      {        "endQuantity": {          "value": "string"        },        "flatAmount": {          "amount": {            "value": "string"          },          "currencyCode": "string"        },        "startQuantity": {          "value": "string"        },        "unitPrice": {          "amount": {            "value": "string"          },          "currencyCode": "string"        }      }    ]  },  "unit": {    "unitPrice": {      "amount": {        "value": "string"      },      "currencyCode": "string"    },    "unitSize": {      "value": "string"    }  }}

200application/json

400application/json

401application/json

403application/json

defaultapplication/json

200application/json

400application/json

401application/json

403application/json

defaultapplication/json

200application/json

400application/json

401application/json

403application/json

defaultapplication/json

200application/json

400application/json

401application/json

403application/json

defaultapplication/json

200application/json

400application/json

401application/json

403application/json

defaultapplication/json

200application/json

400application/json

401application/json

403application/json

defaultapplication/json

200application/json

400application/json

401application/json

403application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`