Delete a Price

DELETE

prices

{id}

curl --request DELETE \
  --url https://eu.sequencehq.com/api/prices/{id} \
  --header 'Authorization: <authorization>'

{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
  "name": "Demo 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",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "123",
      "isPending": false
    }
  ],
  "customMetricParameters": [
    {
      "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "value": "10"
    }
  ],
  "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
  "usageCalculationPeriod": {
    "frequency": "MONTHLY",
    "interval": 1
  },
  "status": "ACTIVE"
}

Headers

Authorization

string

required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version

enum<string>

Use this header to select an API version

Available options:

2024-07-30

Path Parameters

string

required

Unique Price ID

Response

200

application/json

string

required

Unique Price ID, generated by Sequence on creation.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

productId

string

required

The ID of the Product that this Price is associated with.

Example:

"d07037d5-3e31-4c3a-a360-e58555e2bf44"

name

string

required

A short form description of the price, which appears as the title of line items on invoices.

Example:

"Demo Product"

currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

INR,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

Example:

{
  "price": "150.00",
  "pricingType": "ONE_TIME"
}

billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

Example:

"IN_ARREARS"

createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

Example:

[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]

customMetricParameters

object[]

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.

Example:

[
  {
    "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "value": "10"
  }
]

status

enum<string>

required

Price status:

DRAFT means the price has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a price is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

listPriceId

string

The list price ID, if this price variant was created from a list price

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

string

required

Unique Price ID, generated by Sequence on creation.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

productId

string

required

The ID of the Product that this Price is associated with.

Example:

"d07037d5-3e31-4c3a-a360-e58555e2bf44"

name

string

required

A short form description of the price, which appears as the title of line items on invoices.

Example:

"Demo Product"

currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

INR,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

Example:

{
  "price": "150.00",
  "pricingType": "ONE_TIME"
}

billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

Example:

"IN_ARREARS"

createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

Example:

[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]

customMetricParameters

object[]

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.

Example:

[
  {
    "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "value": "10"
  }
]

status

enum<string>

required

Price status:

DRAFT means the price has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a price is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

listPriceId

string

The list price ID, if this price variant was created from a list price

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

string

required

Unique Price ID, generated by Sequence on creation.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

productId

string

required

The ID of the Product that this Price is associated with.

Example:

"d07037d5-3e31-4c3a-a360-e58555e2bf44"

name

string

required

A short form description of the price, which appears as the title of line items on invoices.

Example:

"Demo Product"

currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

INR,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

Example:

{ "price": "20.00", "pricingType": "FIXED" }

billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

Example:

"IN_ARREARS"

createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

Example:

[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]

customMetricParameters

object[]

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.

Example:

[
  {
    "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "value": "10"
  }
]

status

enum<string>

required

Price status:

DRAFT means the price has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a price is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

listPriceId

string

The list price ID, if this price variant was created from a list price

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

string

required

Unique Price ID, generated by Sequence on creation.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

productId

string

required

The ID of the Product that this Price is associated with.

Example:

"d07037d5-3e31-4c3a-a360-e58555e2bf44"

name

string

required

A short form description of the price, which appears as the title of line items on invoices.

Example:

"Demo Product"

currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

INR,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

Example:

{
  "pricePerUnit": "0.25",
  "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
  "isPricePercentage": false,
  "pricingType": "LINEAR"
}

billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

Example:

"IN_ARREARS"

createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

Example:

[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]

customMetricParameters

object[]

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.

Example:

[
  {
    "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "value": "10"
  }
]

status

enum<string>

required

Price status:

DRAFT means the price has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a price is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

listPriceId

string

The list price ID, if this price variant was created from a list price

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

string

required

Unique Price ID, generated by Sequence on creation.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

productId

string

required

The ID of the Product that this Price is associated with.

Example:

"d07037d5-3e31-4c3a-a360-e58555e2bf44"

name

string

required

A short form description of the price, which appears as the title of line items on invoices.

Example:

"Demo Product"

currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

INR,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

Example:

{
  "packageSize": "50",
  "pricePerPackage": "2.00",
  "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
  "pricingType": "PACKAGE"
}

billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

Example:

"IN_ARREARS"

createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

Example:

[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]

customMetricParameters

object[]

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.

Example:

[
  {
    "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "value": "10"
  }
]

status

enum<string>

required

Price status:

DRAFT means the price has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a price is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

listPriceId

string

The list price ID, if this price variant was created from a list price

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

string

required

Unique Price ID, generated by Sequence on creation.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

productId

string

required

The ID of the Product that this Price is associated with.

Example:

"d07037d5-3e31-4c3a-a360-e58555e2bf44"

name

string

required

A short form description of the price, which appears as the title of line items on invoices.

Example:

"Demo Product"

currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

INR,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

structure.seatMetricId

string

required

Seat metric associated to this pricing structure

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

structure.pricePerSeat

string

required

Price charged per seat per full billing period

Example:

"0.25"

structure.prorationStrategy

enum<string>

required

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

Available options:

USE_MAXIMUM,

PRORATE_INCREMENTS,

PRORATE_ALL_CHANGES

Example:

"USE_MAXIMUM"

structure.contractedMinimumSeats

integer

required

The number of contractually agreed minimum seats

Example:

10

structure.tiers

object[]

required

A list of contiguous pricing tiers

Example:

[
  {
    "upperBound": "100",
    "price": "1.00",
    "fee": "50.00"
  },
  { "price": "0.75", "fee": "25.00" }
]

structure.pricingType

enum<string>

required

The type of pricing

Available options:

SEAT_BASED

Example:

"SEAT_BASED"

structure.overagesBillingFrequency

enum<string>

The frequency with which to charge overages

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

structure.prorateFlatFees

boolean

If set any flat fees will be pro-rated if the invoice service period length does not match the billing frequency

Example:

false

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"
}

billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

Example:

"IN_ARREARS"

createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

Example:

[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]

customMetricParameters

object[]

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.

Example:

[
  {
    "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "value": "10"
  }
]

status

enum<string>

required

Price status:

DRAFT means the price has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a price is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

listPriceId

string

The list price ID, if this price variant was created from a list price

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

string

required

Unique Price ID, generated by Sequence on creation.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

productId

string

required

The ID of the Product that this Price is associated with.

Example:

"d07037d5-3e31-4c3a-a360-e58555e2bf44"

name

string

required

A short form description of the price, which appears as the title of line items on invoices.

Example:

"Demo Product"

currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

INR,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

structure.tiers

object[]

required

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
  }
]

structure.usageMetricId

string

required

The usage metric associated to this pricing structure

Example:

"04c62961-04ba-48e6-b985-758bb7d3e712"

structure.usageCalculationMode

enum<string>

required

Indicates the scope of usage calculation

Available options:

BILLING_PERIOD,

CUMULATIVE,

PERIODIC

Example:

"BILLING_PERIOD"

structure.pricingType

enum<string>

required

The type of pricing

Available options:

GRADUATED

Example:

"GRADUATED"

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"
}

billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

Example:

"IN_ARREARS"

createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

Example:

[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]

customMetricParameters

object[]

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.

Example:

[
  {
    "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "value": "10"
  }
]

status

enum<string>

required

Price status:

DRAFT means the price has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a price is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

listPriceId

string

The list price ID, if this price variant was created from a list price

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

usageCalculationPeriod

object

The period over which usage is aggregated.

Example:

{ "frequency": "MONTHLY", "interval": 1 }

string

required

Unique Price ID, generated by Sequence on creation.

Example:

"bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730"

productId

string

required

The ID of the Product that this Price is associated with.

Example:

"d07037d5-3e31-4c3a-a360-e58555e2bf44"

name

string

required

A short form description of the price, which appears as the title of line items on invoices.

Example:

"Demo Product"

currency

enum<string>

required

The currency in which this price is denominated. This must be a valid ISO 4217 currency code, that is currently part of currencies supported by Sequence.

Available options:

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CNY,

COP,

CZK,

DKK,

EUR,

GBP,

HKD,

ILS,

INR,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

structure

object

required

The pricing structure for this price. This can be a simple fixed price, or a more complex structure that varies based on usage.

structure.tiers

object[]

required

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"
  }
]

structure.usageMetricId

string

required

The usage metric associated to this tier

Example:

"04c62961-04ba-48e6-b985-758bb7d3e712"

structure.pricingType

enum<string>

required

The type of pricing

Available options:

VOLUME

Example:

"VOLUME"

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"
}

billingFrequency

enum<string>

required

The frequency with which this price is billed.

Available options:

ON_DEMAND,

ONE_TIME,

MONTHLY,

QUARTERLY,

HALF_YEARLY,

YEARLY

Example:

"MONTHLY"

billingType

enum<string>

required

Indicate at which point of the billing period to generate the invoice for this price. This can be either in-arrears (after the period ends), or in-advnace (at the beginning of the period).

Available options:

IN_ARREARS,

IN_ADVANCE

Example:

"IN_ARREARS"

createdAt

string

required

Time at which the Price was initially created, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

integrationIds

object[]

required

Alternate IDs for this Price in third-party integration systems

Example:

[
  {
    "service": "Xero",
    "id": "123",
    "isPending": false
  }
]

customMetricParameters

object[]

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.

Example:

[
  {
    "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "value": "10"
  }
]

status

enum<string>

required

Price status:

DRAFT means the price has been extracted from a contract and has not yet been approved. It cannot be used while it is in DRAFT.
ACTIVE is the default state when a price is created via API or dashboard.

Available options:

DRAFT,

ACTIVE

Example:

"ACTIVE"

updatedAt

string

Time at which the Price was last updated, in ISO 8601 format.

Example:

"2022-06-28T16:47:00Z"

listPriceId

string

The list price ID, if this price variant was created from a list price

Example:

"b4d7e884-e007-4183-8355-4771865c5100"

Update a Price

Update a Price Usage Metric

curl --request DELETE \
  --url https://eu.sequencehq.com/api/prices/{id} \
  --header 'Authorization: <authorization>'

{
  "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
  "productId": "d07037d5-3e31-4c3a-a360-e58555e2bf44",
  "name": "Demo 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",
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "integrationIds": [
    {
      "service": "Xero",
      "id": "123",
      "isPending": false
    }
  ],
  "customMetricParameters": [
    {
      "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "value": "10"
    }
  ],
  "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
  "usageCalculationPeriod": {
    "frequency": "MONTHLY",
    "interval": 1
  },
  "status": "ACTIVE"
}

API Reference

Latest Live API

Version 2024-07-30

Headers

Path Parameters

Response