--- title: "Update a Price" method: PUT path: "/prices/{id}" tags: ["Prices"] --- # Update a Price `PUT /prices/{id}` Update a Price ## Path parameters - `id` string, required ## Headers - `Authorization` string, required - `sequence-version` '2024-07-30' ## Request body - UpdatePriceRequest - `name` string, required — The customer-facing name of this Price - `status` 'DRAFT' | 'ACTIVE' ## Response `200` OK - union - OneTimePriceResponse - `id` string, required — Unique Price ID, generated by Sequence on creation. - `productId` string, required — The ID of the Product that this Price is associated with. - `name` string, required — A short form description of the price, which appears as the title of line items on invoices. - `currency` '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', required - `structure` OneTimePricingStructure, required — The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage. - `price` string, required — A fixed amount that is charged once. - `pricingType` 'ONE_TIME', required - `billingFrequency` 'ON_DEMAND' | 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'PER_EVENT', required - `billingType` 'IN_ARREARS' | 'IN_ADVANCE', required - `createdAt` string, required — Time at which the Price was initially created, in ISO 8601 format. - `updatedAt` string — Time at which the Price was last updated, in ISO 8601 format. - `integrationIds` IntegrationId1[], required — Alternate IDs for this Price in third-party integration systems - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required - `id` string, required - `isPending` boolean, required - `customMetricParameters` PriceParameter[], required — Specific parameters to influence usage calculation for this Price, and are only required when using custom metric. Please speak to your Sequence contacts for further information prior to usage. - `parameterId` string, required — Custom metric parameter ID - `value` string, required — Parameter value - `listPriceId` string — The list price ID, if this price variant was created from a list price - `status` 'DRAFT' | 'ACTIVE', required - FixedPriceResponse - `id` string, required — Unique Price ID, generated by Sequence on creation. - `productId` string, required — The ID of the Product that this Price is associated with. - `name` string, required — A short form description of the price, which appears as the title of line items on invoices. - `currency` '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', required - `structure` FixedPricingStructure, required — The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage. - `price` string, required — A fixed amount that is charged once every billing period. - `pricingType` 'FIXED', required - `billingFrequency` 'ON_DEMAND' | 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'PER_EVENT', required - `billingType` 'IN_ARREARS' | 'IN_ADVANCE', required - `createdAt` string, required — Time at which the Price was initially created, in ISO 8601 format. - `updatedAt` string — Time at which the Price was last updated, in ISO 8601 format. - `integrationIds` IntegrationId1[], required — Alternate IDs for this Price in third-party integration systems - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required - `id` string, required - `isPending` boolean, required - `customMetricParameters` PriceParameter[], required — Specific parameters to influence usage calculation for this Price, and are only required when using custom metric. Please speak to your Sequence contacts for further information prior to usage. - `parameterId` string, required — Custom metric parameter ID - `value` string, required — Parameter value - `listPriceId` string — The list price ID, if this price variant was created from a list price - `status` 'DRAFT' | 'ACTIVE', required - LinearPriceResponse - `id` string, required — Unique Price ID, generated by Sequence on creation. - `productId` string, required — The ID of the Product that this Price is associated with. - `name` string, required — A short form description of the price, which appears as the title of line items on invoices. - `currency` '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', required - `structure` LinearPricingStructure, required — The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage. - `pricePerUnit` string, required — 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%. - `usageMetricId` string, required — Usage metric associated to this pricing structure - `isPricePercentage` boolean, required — Indicate whether the price attribute is to be considered as a percentage or an absolute value. - `pricingType` 'LINEAR', required - `billingFrequency` 'ON_DEMAND' | 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'PER_EVENT', required - `billingType` 'IN_ARREARS' | 'IN_ADVANCE', required - `createdAt` string, required — Time at which the Price was initially created, in ISO 8601 format. - `updatedAt` string — Time at which the Price was last updated, in ISO 8601 format. - `integrationIds` IntegrationId1[], required — Alternate IDs for this Price in third-party integration systems - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required - `id` string, required - `isPending` boolean, required - `customMetricParameters` PriceParameter[], required — Specific parameters to influence usage calculation for this Price, and are only required when using custom metric. Please speak to your Sequence contacts for further information prior to usage. - `parameterId` string, required — Custom metric parameter ID - `value` string, required — Parameter value - `listPriceId` string — The list price ID, if this price variant was created from a list price - `status` 'DRAFT' | 'ACTIVE', required - PackagePriceResponse - `id` string, required — Unique Price ID, generated by Sequence on creation. - `productId` string, required — The ID of the Product that this Price is associated with. - `name` string, required — A short form description of the price, which appears as the title of line items on invoices. - `currency` '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', required - `structure` PackagePricingStructure, required — The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage. - `packageSize` string, required — The amount of usage allowed for the price in this structure - `pricePerPackage` string, required — The price charged for each package - `usageMetricId` string, required — The usage metric associated to this tier - `pricingType` 'PACKAGE', required - `billingFrequency` 'ON_DEMAND' | 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'PER_EVENT', required - `billingType` 'IN_ARREARS' | 'IN_ADVANCE', required - `createdAt` string, required — Time at which the Price was initially created, in ISO 8601 format. - `updatedAt` string — Time at which the Price was last updated, in ISO 8601 format. - `integrationIds` IntegrationId1[], required — Alternate IDs for this Price in third-party integration systems - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required - `id` string, required - `isPending` boolean, required - `customMetricParameters` PriceParameter[], required — Specific parameters to influence usage calculation for this Price, and are only required when using custom metric. Please speak to your Sequence contacts for further information prior to usage. - `parameterId` string, required — Custom metric parameter ID - `value` string, required — Parameter value - `listPriceId` string — The list price ID, if this price variant was created from a list price - `status` 'DRAFT' | 'ACTIVE', required - SeatBasedPriceResponse - `id` string, required — Unique Price ID, generated by Sequence on creation. - `productId` string, required — The ID of the Product that this Price is associated with. - `name` string, required — A short form description of the price, which appears as the title of line items on invoices. - `currency` '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', required - `structure` SeatBasedPricingStructure, required — The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage. - `seatMetricId` string, required — Seat metric associated to this pricing structure - `pricePerSeat` string, required — Price charged per seat per full billing period - `prorationStrategy` 'USE_MAXIMUM' | 'PRORATE_INCREMENTS' | 'PRORATE_ALL_CHANGES', required - `contractedMinimumSeats` integer, required — The number of contractually agreed minimum seats - `overagesBillingFrequency` 'NONE' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' - `tiers` SeatUsageTier[], required — A list of contiguous pricing tiers - `upperBound` string — 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. - `price` string, required — 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%. - `fee` string — The nominal fee associated with usage at this tier - `prorateFlatFees` boolean — If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency - `pricingType` 'SEAT_BASED', required - `billingFrequency` 'ON_DEMAND' | 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'PER_EVENT', required - `billingType` 'IN_ARREARS' | 'IN_ADVANCE', required - `createdAt` string, required — Time at which the Price was initially created, in ISO 8601 format. - `updatedAt` string — Time at which the Price was last updated, in ISO 8601 format. - `integrationIds` IntegrationId1[], required — Alternate IDs for this Price in third-party integration systems - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required - `id` string, required - `isPending` boolean, required - `customMetricParameters` PriceParameter[], required — Specific parameters to influence usage calculation for this Price, and are only required when using custom metric. Please speak to your Sequence contacts for further information prior to usage. - `parameterId` string, required — Custom metric parameter ID - `value` string, required — Parameter value - `listPriceId` string — The list price ID, if this price variant was created from a list price - `status` 'DRAFT' | 'ACTIVE', required - GraduatedPriceResponse - `id` string, required — Unique Price ID, generated by Sequence on creation. - `productId` string, required — The ID of the Product that this Price is associated with. - `name` string, required — A short form description of the price, which appears as the title of line items on invoices. - `currency` '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', required - `structure` GraduatedPricingStructure, required — The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage. - `tiers` GraduatedUsageTier[], required — A list of contiguous pricing tiers - `upperBound` string — 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. - `price` string, required — 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%. - `fee` string — The nominal fee associated with usage at this tier - `isPricePercentage` boolean, required — Indicate whether the price attribute is to be considered as a percentage or an absolute value. - `usageMetricId` string, required — The usage metric associated to this pricing structure - `usageCalculationMode` 'BILLING_PERIOD' | 'CUMULATIVE' | 'PERIODIC', required - `pricingType` 'GRADUATED', required - `billingFrequency` 'ON_DEMAND' | 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'PER_EVENT', required - `billingType` 'IN_ARREARS' | 'IN_ADVANCE', required - `createdAt` string, required — Time at which the Price was initially created, in ISO 8601 format. - `updatedAt` string — Time at which the Price was last updated, in ISO 8601 format. - `integrationIds` IntegrationId1[], required — Alternate IDs for this Price in third-party integration systems - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required - `id` string, required - `isPending` boolean, required - `customMetricParameters` PriceParameter[], required — Specific parameters to influence usage calculation for this Price, and are only required when using custom metric. Please speak to your Sequence contacts for further information prior to usage. - `parameterId` string, required — Custom metric parameter ID - `value` string, required — Parameter value - `listPriceId` string — The list price ID, if this price variant was created from a list price - `usageCalculationPeriod` UsageCalculationPeriod — The period over which usage is aggregated. - `frequency` 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY', required - `interval` integer, required — 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. - `status` 'DRAFT' | 'ACTIVE', required - VolumePriceResponse - `id` string, required — Unique Price ID, generated by Sequence on creation. - `productId` string, required — The ID of the Product that this Price is associated with. - `name` string, required — A short form description of the price, which appears as the title of line items on invoices. - `currency` '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', required - `structure` VolumePricingStructure, required — The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage. - `tiers` VolumeUsageTier[], required — A list of contiguous pricing tiers - `upperBound` string — 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. - `price` string, required — 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%. - `fee` string — The nominal fee associated with usage at this tier - `isPricePercentage` boolean, required — Indicate whether the price attribute is to be considered as a percentage or an absolute value. - `maxPrice` string — Maximum Price to Charge for each Unit if Price is Percentage Based - `minPrice` string — Minimum Price to Charge for each Unit if Price is Percentage Based - `usageMetricId` string, required — The usage metric associated to this tier - `pricingType` 'VOLUME', required - `billingFrequency` 'ON_DEMAND' | 'ONE_TIME' | 'MONTHLY' | 'QUARTERLY' | 'HALF_YEARLY' | 'YEARLY' | 'PER_EVENT', required - `billingType` 'IN_ARREARS' | 'IN_ADVANCE', required - `createdAt` string, required — Time at which the Price was initially created, in ISO 8601 format. - `updatedAt` string — Time at which the Price was last updated, in ISO 8601 format. - `integrationIds` IntegrationId1[], required — Alternate IDs for this Price in third-party integration systems - `service` 'Amazon_Redshift' | 'GoCardless' | 'Google_BigQuery' | 'Google_Sheets' | 'HubSpot' | 'NetSuite' | 'QuickBooks_Online' | 'Salesforce' | 'Slack' | 'Snowflake' | 'Stripe' | 'Xero' | 'Avalara' | 'Anrok' | 'Attio' | 'Numeral' | 'Rillet' | 'Sphere', required - `id` string, required - `isPending` boolean, required - `customMetricParameters` PriceParameter[], required — Specific parameters to influence usage calculation for this Price, and are only required when using custom metric. Please speak to your Sequence contacts for further information prior to usage. - `parameterId` string, required — Custom metric parameter ID - `value` string, required — Parameter value - `listPriceId` string — The list price ID, if this price variant was created from a list price - `status` 'DRAFT' | 'ACTIVE', required ## Other responses - `400` — Bad Request - `401` — Unauthorized - `500` — Internal Server Error --- [API](https://skmtc.net/sequencehq/apis/sequence.md) · [All operations](https://skmtc.net/sequencehq/apis/sequence/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sequencehq/sequence/versions/cae64b02699f/schema)