{ "openapi" : "3.0.0", "info" : { "title" : "", "description" : "", "version" : "" }, "servers" : [ { "url" : "https://dev.seqhq.io", "description" : "E2E" }, { "url" : "https://dev.seqhq.io", "description" : "DEV" }, { "url" : "https://sandbox.sequencehq.com", "description" : "SANDBOX" }, { "url" : "https://eu.sequencehq.com", "description" : "PRODUCTION" } ], "tags" : [ { "name" : "Products" }, { "name" : "List Prices" } ], "paths" : { "/products/{id}" : { "get" : { "tags" : [ "Products" ], "summary" : "Get a Product by ID", "description" : "Get a Product by ID", "operationId" : "getProductsById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique Product ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Stable20240730ProductResponse", "example" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } }, "examples" : { "Stable20240730ProductResponse" : { "summary" : "", "value" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "put" : { "tags" : [ "Products" ], "summary" : "Update a Product", "description" : "Update a Product", "operationId" : "putProductsById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique Product ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Stable20240730ProductRequest", "example" : { "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88" } }, "examples" : { "Stable20240730ProductRequest" : { "summary" : "", "value" : { "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Stable20240730ProductResponse", "example" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } }, "examples" : { "Stable20240730ProductResponse" : { "summary" : "", "value" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/products" : { "get" : { "tags" : [ "Products" ], "summary" : "List all Products", "description" : "List all Products", "operationId" : "getProducts", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "query", "description" : "Filter by name", "required" : false, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "after", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.next` or `pagination.previous` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Stable20240730ListResponseModel", "example" : { "items" : [ { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } }, "examples" : { "Stable20240730ListResponseModel" : { "summary" : "", "value" : { "items" : [ { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } } } } } } } }, "post" : { "tags" : [ "Products" ], "summary" : "Create a new Product", "description" : "Create a new Product", "operationId" : "postProducts", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Stable20240730ProductRequest", "example" : { "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88" } }, "examples" : { "Stable20240730ProductRequest" : { "summary" : "", "value" : { "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88" } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "201" : { "description" : "Created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Stable20240730ProductResponse", "example" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } }, "examples" : { "Stable20240730ProductResponse" : { "summary" : "", "value" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/list-prices/{id}" : { "get" : { "tags" : [ "List Prices" ], "summary" : "Get a list price", "description" : "Get a list price by ID", "operationId" : "getListPricesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "oneOf" : [ { "$ref" : "#/components/schemas/OneTimeListPriceResponse" }, { "$ref" : "#/components/schemas/FixedListPriceResponse" }, { "$ref" : "#/components/schemas/LinearListPriceResponse" }, { "$ref" : "#/components/schemas/PackageListPriceResponse" }, { "$ref" : "#/components/schemas/SeatBasedListPriceResponse" }, { "$ref" : "#/components/schemas/GraduatedListPriceResponse" }, { "$ref" : "#/components/schemas/VolumeListPriceResponse" } ] }, "examples" : { "GraduatedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "VolumeListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "SeatBasedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "PackageListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "LinearListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "FixedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "20.00", "pricingType" : "FIXED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "OneTimeListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } } } } } }, "404" : { "description" : "Not Found", "content" : { } } } }, "put" : { "tags" : [ "List Prices" ], "summary" : "Update a list price", "description" : "Update a list price", "operationId" : "putListPricesById", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Unique ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 } }, "oneOf" : [ { "$ref" : "#/components/schemas/OneTimeListPriceRequest" }, { "$ref" : "#/components/schemas/FixedListPriceRequest" }, { "$ref" : "#/components/schemas/LinearListPriceRequest" }, { "$ref" : "#/components/schemas/PackageListPriceRequest" }, { "$ref" : "#/components/schemas/SeatBasedListPriceRequest" }, { "$ref" : "#/components/schemas/GraduatedListPriceRequest" }, { "$ref" : "#/components/schemas/VolumeListPriceRequest" } ] }, "examples" : { "GraduatedListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 } } }, "VolumeListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "SeatBasedListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "PackageListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "LinearListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "FixedListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "20.00", "pricingType" : "FIXED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "OneTimeListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "oneOf" : [ { "$ref" : "#/components/schemas/OneTimeListPriceResponse" }, { "$ref" : "#/components/schemas/FixedListPriceResponse" }, { "$ref" : "#/components/schemas/LinearListPriceResponse" }, { "$ref" : "#/components/schemas/PackageListPriceResponse" }, { "$ref" : "#/components/schemas/SeatBasedListPriceResponse" }, { "$ref" : "#/components/schemas/GraduatedListPriceResponse" }, { "$ref" : "#/components/schemas/VolumeListPriceResponse" } ] }, "examples" : { "GraduatedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "VolumeListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "SeatBasedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "PackageListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "LinearListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "FixedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "20.00", "pricingType" : "FIXED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "OneTimeListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/products/{id}/archive" : { "post" : { "tags" : [ "Products" ], "summary" : "Archive a product", "description" : "Archive one of your products. Once archived, new prices cannot be created for the product.", "operationId" : "postProductsByIdArchive", "parameters" : [ { "name" : "id", "in" : "path", "description" : "Product ID", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "403" : { "description" : "Forbidden", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Stable20240509ProductResponse", "example" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "archivedAt" : "2023-06-28T16:47:00Z" } }, "examples" : { "Stable20240509ProductResponse" : { "summary" : "", "value" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "archivedAt" : "2023-06-28T16:47:00Z" } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/list-prices/{id}/archive" : { "post" : { "tags" : [ "List Prices" ], "summary" : "Archive a list price", "description" : "Mark a list price as archived", "operationId" : "postListPricesByIdArchive", "parameters" : [ { "name" : "id", "in" : "path", "description" : "List Price Id", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "oneOf" : [ { "$ref" : "#/components/schemas/OneTimeListPriceResponse" }, { "$ref" : "#/components/schemas/FixedListPriceResponse" }, { "$ref" : "#/components/schemas/LinearListPriceResponse" }, { "$ref" : "#/components/schemas/PackageListPriceResponse" }, { "$ref" : "#/components/schemas/SeatBasedListPriceResponse" }, { "$ref" : "#/components/schemas/GraduatedListPriceResponse" }, { "$ref" : "#/components/schemas/VolumeListPriceResponse" } ] }, "examples" : { "GraduatedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "VolumeListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "SeatBasedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "PackageListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "LinearListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "FixedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "20.00", "pricingType" : "FIXED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "OneTimeListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } } } } } } } }, "servers" : [ ], "parameters" : [ ] }, "/list-prices" : { "get" : { "tags" : [ "List Prices" ], "summary" : "List all list prices", "description" : "List all list prices", "operationId" : "getListPrices", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "currency", "in" : "query", "description" : "Filter by currency.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "productId", "in" : "query", "description" : "Filter list prices by a given product ID.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "billingFrequency", "in" : "query", "description" : "Filter by billing frequency.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "includeArchived", "in" : "query", "description" : "Include archived list prices in results", "required" : false, "schema" : { "type" : "boolean" } }, { "name" : "limit", "in" : "query", "description" : "Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).", "required" : false, "schema" : { "type" : "integer" } }, { "name" : "after", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.after` or `pagination.before` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "before", "in" : "query", "description" : "Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from `pagination.next` or `pagination.previous` to retrieve each page.", "required" : false, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "example" : { "items" : [ { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } }, "oneOf" : [ { "$ref" : "#/components/schemas/ListListPricesEndpointResponseModel" } ] }, "examples" : { "ListListPricesEndpointResponseModel" : { "summary" : "", "value" : { "items" : [ { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } } } } } } } } }, "post" : { "tags" : [ "List Prices" ], "summary" : "Create a list price", "description" : "Create a new list price", "operationId" : "postListPrices", "parameters" : [ { "name" : "Authorization", "in" : "header", "description" : "Your [API credentials](/reference/authentication). Eg. `Basic {credentials}`.", "required" : true, "schema" : { "type" : "string" } }, { "name" : "sequence-version", "in" : "header", "description" : "Use this header to select an API version", "required" : false, "schema" : { "type" : "string", "enum" : [ "2024-07-30" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 } }, "oneOf" : [ { "$ref" : "#/components/schemas/OneTimeListPriceRequest" }, { "$ref" : "#/components/schemas/FixedListPriceRequest" }, { "$ref" : "#/components/schemas/LinearListPriceRequest" }, { "$ref" : "#/components/schemas/PackageListPriceRequest" }, { "$ref" : "#/components/schemas/SeatBasedListPriceRequest" }, { "$ref" : "#/components/schemas/GraduatedListPriceRequest" }, { "$ref" : "#/components/schemas/VolumeListPriceRequest" } ] }, "examples" : { "GraduatedListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 } } }, "VolumeListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "SeatBasedListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "PackageListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "LinearListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "FixedListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "20.00", "pricingType" : "FIXED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } }, "OneTimeListPriceRequest" : { "summary" : "", "value" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] } } } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { } }, "401" : { "description" : "Unauthorized", "content" : { } }, "500" : { "description" : "Internal Server Error", "content" : { } }, "201" : { "description" : "Created", "content" : { "application/json" : { "schema" : { "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "oneOf" : [ { "$ref" : "#/components/schemas/OneTimeListPriceResponse" }, { "$ref" : "#/components/schemas/FixedListPriceResponse" }, { "$ref" : "#/components/schemas/LinearListPriceResponse" }, { "$ref" : "#/components/schemas/PackageListPriceResponse" }, { "$ref" : "#/components/schemas/SeatBasedListPriceResponse" }, { "$ref" : "#/components/schemas/GraduatedListPriceResponse" }, { "$ref" : "#/components/schemas/VolumeListPriceResponse" } ] }, "examples" : { "GraduatedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "VolumeListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "SeatBasedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "PackageListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "LinearListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "FixedListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "20.00", "pricingType" : "FIXED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } }, "OneTimeListPriceResponse" : { "summary" : "", "value" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } } } } } } } }, "servers" : [ ], "parameters" : [ ] } }, "components" : { "schemas" : { "Stable20240730ProductRequest" : { "required" : [ "name" ], "type" : "object", "example" : { "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "properties" : { "name" : { "type" : "string", "description" : "Name of the Product, this appears within Sequence's dashboard.", "example" : "Fixed priced product" }, "label" : { "type" : "string", "description" : "The internal description of the product. This can be used to maintain some explanation or comments regarding the product.", "example" : "Fixed priced product - UK" }, "taxCategoryId" : { "type" : "string", "description" : "The internal ID of the tax category associated with this product.", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" } } }, "Stable20240730ProductResponse" : { "required" : [ "createdAt", "id", "name", "updatedAt" ], "type" : "object", "example" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" }, "properties" : { "id" : { "type" : "string", "description" : "Product ID", "example" : "994d23f7-47b6-43ee-af6b-cd27181196b6" }, "name" : { "type" : "string", "description" : "Name of the Product, this appears within Sequence's dashboard.", "example" : "Fixed priced product" }, "label" : { "type" : "string", "description" : "The internal description of the product. This can be used to maintain some explanation or comments regarding the product.", "example" : "Fixed priced product - UK" }, "taxCategoryId" : { "type" : "string", "description" : "The internal ID of the tax category associated with this product.", "example" : "3271ca41-d538-404f-a15f-25856a37fb88" }, "createdAt" : { "type" : "string", "description" : "Time at which the Product was first created, in ISO 8601 format (UTC). This is set by the server and cannot be changed. Expect millisecond precision.", "example" : "2022-06-28T16:47:00Z" }, "updatedAt" : { "type" : "string", "description" : "Time at which the Product was last updated, in ISO 8601 format (UTC). Expect millisecond precision.", "example" : "2022-06-28T16:47:00Z" } } }, "Stable20240730ListResponseModel" : { "required" : [ "items", "pagination" ], "type" : "object", "example" : { "items" : [ { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } }, "properties" : { "items" : { "type" : "array", "description" : "Products", "example" : [ { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "taxCategoryId" : "3271ca41-d538-404f-a15f-25856a37fb88", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z" } ], "items" : { "$ref" : "#/components/schemas/Stable20240730ProductResponse" } }, "pagination" : { "$ref" : "#/components/schemas/PaginationMeta" } } }, "PaginationMeta" : { "type" : "object", "description" : "Results pagination", "example" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 }, "properties" : { "after" : { "type" : "string", "description" : "Cursor for the page after this (if it exists)", "example" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3" }, "before" : { "type" : "string", "description" : "Cursor for the page before this (if it exists)", "example" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz" }, "totalResultSize" : { "type" : "integer", "description" : "Total number of entries across all pages", "format" : "int64", "example" : 10 } } }, "Currency" : { "type" : "string", "example" : "GBP", "enum" : [ "AED", "ARS", "AUD", "BRL", "BGN", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "ILS", "INR", "ISK", "JPY", "KRW", "MXN", "NOK", "NZD", "PLN", "SAR", "SEK", "SGD", "THB", "USD", "UYU", "ZAR" ] }, "GraduatedPricingStructure" : { "required" : [ "pricingType", "tiers", "usageCalculationMode", "usageMetricId" ], "type" : "object", "description" : "The pricing structure", "example" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "properties" : { "tiers" : { "type" : "array", "description" : "A list of contiguous pricing tiers", "example" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "items" : { "$ref" : "#/components/schemas/GraduatedUsageTier" } }, "usageMetricId" : { "type" : "string", "description" : "The usage metric associated to this pricing structure", "example" : "04c62961-04ba-48e6-b985-758bb7d3e712" }, "usageCalculationMode" : { "description" : "Indicates the scope of usage calculation", "$ref" : "#/components/schemas/UsageCalculationMode" }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/GraduatedPricingType" } } }, "GraduatedUsageTier" : { "required" : [ "isPricePercentage", "price" ], "type" : "object", "example" : { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, "properties" : { "upperBound" : { "type" : "string", "description" : "The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.", "example" : "200" }, "price" : { "type" : "string", "description" : "The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.", "example" : "1.00" }, "fee" : { "type" : "string", "description" : "The nominal fee associated with usage at this tier", "example" : "50.00" }, "isPricePercentage" : { "type" : "boolean", "description" : "Indicate whether the price attribute is to be considered as a percentage or an absolute value.", "example" : false } } }, "UsageCalculationMode" : { "type" : "string", "example" : "BILLING_PERIOD", "enum" : [ "BILLING_PERIOD", "CUMULATIVE", "PERIODIC" ] }, "PricingType" : { "type" : "string", "example" : "GRADUATED", "enum" : [ "ONE_TIME", "FIXED", "LINEAR", "PACKAGE", "GRADUATED", "VOLUME", "SEAT_BASED" ] }, "BillingFrequency" : { "type" : "string", "example" : "MONTHLY", "enum" : [ "ON_DEMAND", "ONE_TIME", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY", "PER_EVENT" ] }, "BillingType" : { "type" : "string", "example" : "IN_ARREARS", "enum" : [ "IN_ARREARS", "IN_ADVANCE" ] }, "GenerateIntegrationIdRequest" : { "required" : [ "id", "service" ], "type" : "object", "example" : { "service" : "Xero", "id" : "123" }, "properties" : { "service" : { "$ref" : "#/components/schemas/IntegrationService" }, "id" : { "type" : "string", "example" : "123" } } }, "IntegrationService" : { "type" : "string", "example" : "Xero", "enum" : [ "Amazon_Redshift", "GoCardless", "Google_BigQuery", "Google_Sheets", "HubSpot", "NetSuite", "QuickBooks_Online", "Salesforce", "Slack", "Snowflake", "Stripe", "Xero", "Avalara", "Anrok", "Attio", "Numeral", "Rillet", "Sphere" ] }, "PriceParameter" : { "required" : [ "parameterId", "value" ], "type" : "object", "example" : { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" }, "properties" : { "parameterId" : { "type" : "string", "description" : "Custom metric parameter ID", "example" : "94703530-1293-479b-bd37-ccad42fd9c8b" }, "value" : { "type" : "string", "description" : "Parameter value", "example" : "10" } } }, "UsageCalculationPeriod" : { "required" : [ "frequency", "interval" ], "type" : "object", "description" : "The period over which usage is aggregated. This value is only taken into consideration and required with graduated pricing structures with a usage calculation mode of 'PERIOD'. It will be ignored for all non-graduated prices.", "example" : { "frequency" : "QUARTERLY", "interval" : 1 }, "properties" : { "frequency" : { "description" : "Frequency determines the time period over which usage is aggregated.", "$ref" : "#/components/schemas/UsageCalculationFrequency" }, "interval" : { "type" : "integer", "description" : "Interval determines the time period over which usage is aggregated. For example, if the frequency is MONTHLY and the interval is 3, the usage is aggregated over 3 months before starting at 0 again.", "format" : "int32", "example" : 1 } } }, "UsageCalculationFrequency" : { "type" : "string", "example" : "QUARTERLY", "enum" : [ "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ] }, "GraduatedListPriceRequest" : { "required" : [ "billingFrequency", "billingType", "currency", "customMetricParameters", "integrationIds", "name", "productId", "structure" ], "type" : "object", "title" : "GraduatedListPriceRequest", "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 } }, "properties" : { "productId" : { "type" : "string", "description" : "The related product ID", "example" : "d07037d5-3e31-4c3a-a360-e58555e2bf44" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/GraduatedPricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } }, "usageCalculationPeriod" : { "$ref" : "#/components/schemas/UsageCalculationPeriod" } } }, "VolumePricingStructure" : { "required" : [ "pricingType", "tiers", "usageMetricId" ], "type" : "object", "description" : "The pricing structure", "example" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "properties" : { "tiers" : { "type" : "array", "description" : "A list of contiguous pricing tiers", "example" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "items" : { "$ref" : "#/components/schemas/VolumeUsageTier" } }, "usageMetricId" : { "type" : "string", "description" : "The usage metric associated to this tier", "example" : "04c62961-04ba-48e6-b985-758bb7d3e712" }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/VolumePricingType" } } }, "VolumeUsageTier" : { "required" : [ "isPricePercentage", "price" ], "type" : "object", "example" : { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, "properties" : { "upperBound" : { "type" : "string", "description" : "The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.", "example" : "100" }, "price" : { "type" : "string", "description" : "The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.", "example" : "1.00" }, "fee" : { "type" : "string", "description" : "The nominal fee associated with usage at this tier", "example" : "50.00" }, "isPricePercentage" : { "type" : "boolean", "description" : "Indicate whether the price attribute is to be considered as a percentage or an absolute value.", "example" : true }, "maxPrice" : { "type" : "string", "description" : "Maximum Price to Charge for each Unit if Price is Percentage Based", "example" : "10" }, "minPrice" : { "type" : "string", "description" : "Minimum Price to Charge for each Unit if Price is Percentage Based", "example" : "5" } } }, "VolumeListPriceRequest" : { "required" : [ "billingFrequency", "billingType", "currency", "customMetricParameters", "integrationIds", "name", "productId", "structure" ], "type" : "object", "title" : "VolumeListPriceRequest", "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] }, "properties" : { "productId" : { "type" : "string", "description" : "The related product ID", "example" : "d07037d5-3e31-4c3a-a360-e58555e2bf44" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/VolumePricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "SeatBasedPricingStructure" : { "required" : [ "contractedMinimumSeats", "pricePerSeat", "pricingType", "prorationStrategy", "seatMetricId", "tiers" ], "type" : "object", "description" : "The pricing structure", "example" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "properties" : { "seatMetricId" : { "type" : "string", "description" : "Seat metric associated to this pricing structure", "example" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730" }, "pricePerSeat" : { "type" : "string", "description" : "Price charged per seat per full billing period", "example" : "0.25" }, "prorationStrategy" : { "description" : "The proration strategy to use when calculating the price for a seat. A `USE_MAXIMUM` will not prorate and charge the highest seat balance for the entire billing period, while a PRORATE_INCREMENTS will charge incremental seats from the day they're added", "$ref" : "#/components/schemas/SeatProrationStrategy" }, "contractedMinimumSeats" : { "type" : "integer", "description" : "The number of contractually agreed minimum seats", "example" : 10 }, "overagesBillingFrequency" : { "description" : "The frequency with which to charge overages", "$ref" : "#/components/schemas/OveragesFrequency" }, "tiers" : { "type" : "array", "description" : "A list of contiguous pricing tiers", "example" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "items" : { "$ref" : "#/components/schemas/SeatUsageTier" } }, "prorateFlatFees" : { "type" : "boolean", "description" : "If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency", "example" : false }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/SeatBasedPricingType" } } }, "SeatProrationStrategy" : { "type" : "string", "example" : "USE_MAXIMUM", "enum" : [ "USE_MAXIMUM", "PRORATE_INCREMENTS", "PRORATE_ALL_CHANGES" ] }, "OveragesFrequency" : { "type" : "string", "example" : "YEARLY", "enum" : [ "NONE", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ] }, "SeatUsageTier" : { "required" : [ "price" ], "type" : "object", "example" : { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, "properties" : { "upperBound" : { "type" : "string", "description" : "The upper bound of usage for this tier. Set to null to if this is a final tier and is unbounded. The lower bound is set by the previous tier or 0 if it's the first one.", "example" : "100" }, "price" : { "type" : "string", "description" : "The rate to apply to usage for this product in this tier. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.", "example" : "1.00" }, "fee" : { "type" : "string", "description" : "The nominal fee associated with usage at this tier", "example" : "50.00" } } }, "SeatBasedListPriceRequest" : { "required" : [ "billingFrequency", "billingType", "currency", "customMetricParameters", "integrationIds", "name", "productId", "structure" ], "type" : "object", "title" : "SeatBasedListPriceRequest", "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] }, "properties" : { "productId" : { "type" : "string", "description" : "The related product ID", "example" : "d07037d5-3e31-4c3a-a360-e58555e2bf44" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/SeatBasedPricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "PackagePricingStructure" : { "required" : [ "packageSize", "pricePerPackage", "pricingType", "usageMetricId" ], "type" : "object", "description" : "The pricing structure", "example" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "properties" : { "packageSize" : { "type" : "string", "description" : "The amount of usage allowed for the price in this structure", "example" : "50" }, "pricePerPackage" : { "type" : "string", "description" : "The price charged for each package", "example" : "2.00" }, "usageMetricId" : { "type" : "string", "description" : "The usage metric associated to this tier", "example" : "04c62961-04ba-48e6-b985-758bb7d3e712" }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/PackagePricingType" } } }, "PackageListPriceRequest" : { "required" : [ "billingFrequency", "billingType", "currency", "customMetricParameters", "integrationIds", "name", "productId", "structure" ], "type" : "object", "title" : "PackageListPriceRequest", "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] }, "properties" : { "productId" : { "type" : "string", "description" : "The related product ID", "example" : "d07037d5-3e31-4c3a-a360-e58555e2bf44" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/PackagePricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "LinearPricingStructure" : { "required" : [ "isPricePercentage", "pricePerUnit", "pricingType", "usageMetricId" ], "type" : "object", "description" : "The pricing structure", "example" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "properties" : { "pricePerUnit" : { "type" : "string", "description" : "The per unit rate to apply to usage for this product. In the case of percentage pricing where `isPricePercentage` is set to `true`, a value of 1 represents 100%.", "example" : "0.25" }, "usageMetricId" : { "type" : "string", "description" : "Usage metric associated to this pricing structure", "example" : "04c62961-04ba-48e6-b985-758bb7d3e712" }, "isPricePercentage" : { "type" : "boolean", "description" : "Indicate whether the price attribute is to be considered as a percentage or an absolute value.", "example" : false }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/LinearPricingType" } } }, "LinearListPriceRequest" : { "required" : [ "billingFrequency", "billingType", "currency", "customMetricParameters", "integrationIds", "name", "productId", "structure" ], "type" : "object", "title" : "LinearListPriceRequest", "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] }, "properties" : { "productId" : { "type" : "string", "description" : "The related product ID", "example" : "d07037d5-3e31-4c3a-a360-e58555e2bf44" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/LinearPricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "FixedPricingStructure" : { "required" : [ "price", "pricingType" ], "type" : "object", "description" : "The pricing structure", "example" : { "price" : "20.00", "pricingType" : "FIXED" }, "properties" : { "price" : { "type" : "string", "description" : "A fixed amount that is charged once every billing period.", "example" : "20.00" }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/FixedPricingType" } } }, "FixedListPriceRequest" : { "required" : [ "billingFrequency", "billingType", "currency", "customMetricParameters", "integrationIds", "name", "productId", "structure" ], "type" : "object", "title" : "FixedListPriceRequest", "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "20.00", "pricingType" : "FIXED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] }, "properties" : { "productId" : { "type" : "string", "description" : "The related product ID", "example" : "d07037d5-3e31-4c3a-a360-e58555e2bf44" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/FixedPricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "OneTimePricingStructure" : { "required" : [ "price", "pricingType" ], "type" : "object", "description" : "The pricing structure", "example" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "properties" : { "price" : { "type" : "string", "description" : "A fixed amount that is charged once.", "example" : "150.00" }, "pricingType" : { "description" : "The type of pricing", "$ref" : "#/components/schemas/OneTimePricingType" } } }, "OneTimeListPriceRequest" : { "required" : [ "billingFrequency", "billingType", "currency", "customMetricParameters", "integrationIds", "name", "productId", "structure" ], "type" : "object", "title" : "OneTimeListPriceRequest", "example" : { "productId" : "d07037d5-3e31-4c3a-a360-e58555e2bf44", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "integrationIds" : [ { "service" : "Xero", "id" : "123" } ], "customMetricParameters" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ] }, "properties" : { "productId" : { "type" : "string", "description" : "The related product ID", "example" : "d07037d5-3e31-4c3a-a360-e58555e2bf44" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/OneTimePricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123" } ], "items" : { "$ref" : "#/components/schemas/GenerateIntegrationIdRequest" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "94703530-1293-479b-bd37-ccad42fd9c8b", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "IntegrationId" : { "required" : [ "id", "isPending", "service" ], "type" : "object", "example" : { "service" : "Xero", "id" : "123", "isPending" : false }, "properties" : { "service" : { "$ref" : "#/components/schemas/IntegrationService" }, "id" : { "type" : "string", "example" : "123" }, "isPending" : { "type" : "boolean", "example" : false } } }, "GraduatedListPriceResponse" : { "required" : [ "billingFrequency", "billingType", "createdAt", "currency", "customMetricParameters", "id", "integrationIds", "name", "productId", "structure", "updatedAt" ], "type" : "object", "title" : "GraduatedListPriceResponse", "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "properties" : { "id" : { "type" : "string", "description" : "Unique ID", "example" : "b4d7e884-e007-4183-8355-4771865c5100" }, "productId" : { "type" : "string", "description" : "The related product ID", "example" : "f409d651-c475-4142-aafd-a5d2bd74d4f9" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/GraduatedPricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "usageCalculationPeriod" : { "$ref" : "#/components/schemas/UsageCalculationPeriod" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "updatedAt" : { "type" : "string", "description" : "Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "VolumeListPriceResponse" : { "required" : [ "billingFrequency", "billingType", "createdAt", "currency", "customMetricParameters", "id", "integrationIds", "name", "productId", "structure", "updatedAt" ], "type" : "object", "title" : "VolumeListPriceResponse", "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" }, { "price" : "0.75", "fee" : "25.00", "isPricePercentage" : true, "maxPrice" : "10", "minPrice" : "5" } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "VOLUME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "properties" : { "id" : { "type" : "string", "description" : "Unique ID", "example" : "b4d7e884-e007-4183-8355-4771865c5100" }, "productId" : { "type" : "string", "description" : "The related product ID", "example" : "f409d651-c475-4142-aafd-a5d2bd74d4f9" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/VolumePricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "updatedAt" : { "type" : "string", "description" : "Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "SeatBasedListPriceResponse" : { "required" : [ "billingFrequency", "billingType", "createdAt", "currency", "customMetricParameters", "id", "integrationIds", "name", "productId", "structure", "updatedAt" ], "type" : "object", "title" : "SeatBasedListPriceResponse", "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "seatMetricId" : "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730", "pricePerSeat" : "0.25", "prorationStrategy" : "USE_MAXIMUM", "contractedMinimumSeats" : 10, "overagesBillingFrequency" : "YEARLY", "tiers" : [ { "upperBound" : "100", "price" : "1.00", "fee" : "50.00" }, { "price" : "0.75", "fee" : "25.00" } ], "prorateFlatFees" : false, "pricingType" : "SEAT_BASED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "properties" : { "id" : { "type" : "string", "description" : "Unique ID", "example" : "b4d7e884-e007-4183-8355-4771865c5100" }, "productId" : { "type" : "string", "description" : "The related product ID", "example" : "f409d651-c475-4142-aafd-a5d2bd74d4f9" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/SeatBasedPricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "updatedAt" : { "type" : "string", "description" : "Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "PackageListPriceResponse" : { "required" : [ "billingFrequency", "billingType", "createdAt", "currency", "customMetricParameters", "id", "integrationIds", "name", "productId", "structure", "updatedAt" ], "type" : "object", "title" : "PackageListPriceResponse", "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "packageSize" : "50", "pricePerPackage" : "2.00", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "pricingType" : "PACKAGE" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "properties" : { "id" : { "type" : "string", "description" : "Unique ID", "example" : "b4d7e884-e007-4183-8355-4771865c5100" }, "productId" : { "type" : "string", "description" : "The related product ID", "example" : "f409d651-c475-4142-aafd-a5d2bd74d4f9" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/PackagePricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "updatedAt" : { "type" : "string", "description" : "Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "LinearListPriceResponse" : { "required" : [ "billingFrequency", "billingType", "createdAt", "currency", "customMetricParameters", "id", "integrationIds", "name", "productId", "structure", "updatedAt" ], "type" : "object", "title" : "LinearListPriceResponse", "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "pricePerUnit" : "0.25", "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "isPricePercentage" : false, "pricingType" : "LINEAR" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "properties" : { "id" : { "type" : "string", "description" : "Unique ID", "example" : "b4d7e884-e007-4183-8355-4771865c5100" }, "productId" : { "type" : "string", "description" : "The related product ID", "example" : "f409d651-c475-4142-aafd-a5d2bd74d4f9" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/LinearPricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "updatedAt" : { "type" : "string", "description" : "Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "FixedListPriceResponse" : { "required" : [ "billingFrequency", "billingType", "createdAt", "currency", "customMetricParameters", "id", "integrationIds", "name", "productId", "structure", "updatedAt" ], "type" : "object", "title" : "FixedListPriceResponse", "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "20.00", "pricingType" : "FIXED" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "properties" : { "id" : { "type" : "string", "description" : "Unique ID", "example" : "b4d7e884-e007-4183-8355-4771865c5100" }, "productId" : { "type" : "string", "description" : "The related product ID", "example" : "f409d651-c475-4142-aafd-a5d2bd74d4f9" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/FixedPricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "updatedAt" : { "type" : "string", "description" : "Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "OneTimeListPriceResponse" : { "required" : [ "billingFrequency", "billingType", "createdAt", "currency", "customMetricParameters", "id", "integrationIds", "name", "productId", "structure", "updatedAt" ], "type" : "object", "title" : "OneTimeListPriceResponse", "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "price" : "150.00", "pricingType" : "ONE_TIME" }, "billingFrequency" : "MONTHLY", "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "properties" : { "id" : { "type" : "string", "description" : "Unique ID", "example" : "b4d7e884-e007-4183-8355-4771865c5100" }, "productId" : { "type" : "string", "description" : "The related product ID", "example" : "f409d651-c475-4142-aafd-a5d2bd74d4f9" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "$ref" : "#/components/schemas/OneTimePricingStructure" }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "updatedAt" : { "type" : "string", "description" : "Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "Stable20240509ProductResponse" : { "required" : [ "createdAt", "id", "name", "updatedAt" ], "type" : "object", "example" : { "id" : "994d23f7-47b6-43ee-af6b-cd27181196b6", "name" : "Fixed priced product", "label" : "Fixed priced product - UK", "createdAt" : "2022-06-28T16:47:00Z", "updatedAt" : "2022-06-28T16:47:00Z", "archivedAt" : "2023-06-28T16:47:00Z" }, "properties" : { "id" : { "type" : "string", "description" : "Product ID", "example" : "994d23f7-47b6-43ee-af6b-cd27181196b6" }, "name" : { "type" : "string", "description" : "Name of the Product, this appears within Sequence's dashboard.", "example" : "Fixed priced product" }, "label" : { "type" : "string", "description" : "The internal description of the product. This can be used to maintain some explanation or comments regarding the product.", "example" : "Fixed priced product - UK" }, "createdAt" : { "type" : "string", "description" : "Time at which the Product was first created, in ISO 8601 format (UTC). This is set by the server and cannot be changed. Expect millisecond precision.", "example" : "2022-06-28T16:47:00Z" }, "updatedAt" : { "type" : "string", "description" : "Time at which the Product was last updated, in ISO 8601 format (UTC). Expect millisecond precision.", "example" : "2022-06-28T16:47:00Z" }, "archivedAt" : { "type" : "string", "description" : "Time at which the Product was archived, in ISO 8601 format (UTC). Expect millisecond precision.", "example" : "2023-06-28T16:47:00Z" } } }, "ListListPricesEndpointResponseModel" : { "required" : [ "items", "pagination" ], "type" : "object", "example" : { "items" : [ { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } ], "pagination" : { "after" : "MDE4NDUyNjYtNmQ2NC03N2M4LTlhZGYtNDQ4N2Q5NGQxNDU3", "before" : "MDE4NDQyMWUtYTljYy03MTFiLWFmOTMtYmYwNTExZDRkODMz", "totalResultSize" : 10 } }, "properties" : { "items" : { "type" : "array", "description" : "List prices", "example" : [ { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] } ], "items" : { "$ref" : "#/components/schemas/ListPrice" } }, "pagination" : { "$ref" : "#/components/schemas/PaginationMeta" } } }, "ListPrice" : { "required" : [ "billingFrequency", "billingType", "createdAt", "currency", "customMetricParameters", "id", "integrationIds", "name", "productId", "structure", "updatedAt" ], "type" : "object", "example" : { "id" : "b4d7e884-e007-4183-8355-4771865c5100", "productId" : "f409d651-c475-4142-aafd-a5d2bd74d4f9", "name" : "Sample product", "currency" : "GBP", "structure" : { "tiers" : [ { "upperBound" : "200", "price" : "1.00", "fee" : "50.00", "isPricePercentage" : false }, { "upperBound" : "400", "price" : "0.75", "fee" : "25.00", "isPricePercentage" : false }, { "price" : "0.50", "fee" : "0.00", "isPricePercentage" : false } ], "usageMetricId" : "04c62961-04ba-48e6-b985-758bb7d3e712", "usageCalculationMode" : "BILLING_PERIOD", "pricingType" : "GRADUATED" }, "billingFrequency" : "MONTHLY", "usageCalculationPeriod" : { "frequency" : "QUARTERLY", "interval" : 1 }, "billingType" : "IN_ARREARS", "createdAt" : "2021-08-25T12:00:00Z", "updatedAt" : "2021-08-25T12:00:00Z", "integrationIds" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "customMetricParameters" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ] }, "properties" : { "id" : { "type" : "string", "description" : "Unique ID", "example" : "b4d7e884-e007-4183-8355-4771865c5100" }, "productId" : { "type" : "string", "description" : "The related product ID", "example" : "f409d651-c475-4142-aafd-a5d2bd74d4f9" }, "name" : { "type" : "string", "description" : "The customer-facing name of this list price", "example" : "Sample product" }, "currency" : { "description" : "The pricing currency", "$ref" : "#/components/schemas/Currency" }, "structure" : { "oneOf" : [ { "$ref" : "#/components/schemas/GraduatedPricingStructure" }, { "$ref" : "#/components/schemas/VolumePricingStructure" }, { "$ref" : "#/components/schemas/SeatBasedPricingStructure" }, { "$ref" : "#/components/schemas/PackagePricingStructure" }, { "$ref" : "#/components/schemas/LinearPricingStructure" }, { "$ref" : "#/components/schemas/FixedPricingStructure" }, { "$ref" : "#/components/schemas/OneTimePricingStructure" } ] }, "billingFrequency" : { "description" : "The recurrence of charging this price.", "$ref" : "#/components/schemas/BillingFrequency" }, "usageCalculationPeriod" : { "$ref" : "#/components/schemas/UsageCalculationPeriod" }, "billingType" : { "description" : "How to bill this price: in-arrears or in-advance.", "$ref" : "#/components/schemas/BillingType" }, "createdAt" : { "type" : "string", "description" : "Creation timestamp. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "updatedAt" : { "type" : "string", "description" : "Timestamp when price was last updated. Formatted as an ISO 8601 timestamp.", "example" : "2021-08-25T12:00:00Z" }, "integrationIds" : { "type" : "array", "description" : "Alternate IDs for this price in third-party integration systems", "example" : [ { "service" : "Xero", "id" : "123", "isPending" : false } ], "items" : { "$ref" : "#/components/schemas/IntegrationId" } }, "customMetricParameters" : { "type" : "array", "description" : "Specific parameters to influence usage calculation for this price, and are only required when using a custom metric. Please speak to your Sequence contacts for further information prior to usage.", "example" : [ { "parameterId" : "2963e49a-c8e0-4673-89f5-7a805c0faf14", "value" : "10" } ], "items" : { "$ref" : "#/components/schemas/PriceParameter" } } } }, "OneTimePricingType" : { "type" : "string", "example" : "ONE_TIME", "enum" : [ "ONE_TIME" ] }, "FixedPricingType" : { "type" : "string", "example" : "FIXED", "enum" : [ "FIXED" ] }, "LinearPricingType" : { "type" : "string", "example" : "LINEAR", "enum" : [ "LINEAR" ] }, "PackagePricingType" : { "type" : "string", "example" : "PACKAGE", "enum" : [ "PACKAGE" ] }, "GraduatedPricingType" : { "type" : "string", "example" : "GRADUATED", "enum" : [ "GRADUATED" ] }, "VolumePricingType" : { "type" : "string", "example" : "VOLUME", "enum" : [ "VOLUME" ] }, "SeatBasedPricingType" : { "type" : "string", "example" : "SEAT_BASED", "enum" : [ "SEAT_BASED" ] } }, "requestBodies" : { }, "securitySchemes" : { } } }