Create Bundle

POST

price-bundles

{
  "name": "Premium Bundle",
  "description": "A bundle including premium features and services.",
  "prices": [
    {
      "type": "unit",
      "productId": {
        "Type": "digital"
      },
      "billingInterval": "monthly",
      "unitPricingModel": {
        "pricePerUnit": {
          "value": "59.99"
        }
      },
      "tieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "pricePerUnit": {
              "value": "0.10"
            },
            "fixedFee": {
              "value": "5.00"
            }
          }
        ]
      },
      "fixedPricingModel": {
        "pricePerUnit": {
          "value": "24.99"
        },
        "units": 2,
        "total": {
          "value": "49.98"
        }
      },
      "graduatedPercentagePricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "fixedFee": {
              "value": "10.00"
            },
            "percentage": {
              "value": "15"
            }
          }
        ]
      },
      "prepaidFixedTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 50,
            "pricePerUnit": {
              "value": "0.15"
            },
            "fixedFee": {
              "value": "2.00"
            }
          }
        ],
        "units": 100
      },
      "prepaidTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 75,
            "pricePerUnit": {
              "value": "0.20"
            },
            "fixedFee": {
              "value": "3.00"
            }
          }
        ],
        "units": 50
      },
      "volumePercentagePricingModel": {
        "pricePerUnit": {
          "value": "0.05"
        },
        "percentage": {
          "value": "10"
        },
        "fixedFee": {
          "value": "5.00"
        }
      },
      "discount": {
        "discountType": "percentage",
        "amount": {
          "value": "10.00"
        },
        "periodLength": 6,
        "periodType": "months",
        "endDate": "2009-11-10T23:00:00Z"
      },
      "trialPeriodDays": 30,
      "minimumSpend": {
        "amount": {
          "value": "100.00"
        },
        "period": "monthly"
      },
      "maximumSpend": {
        "amount": {
          "value": "500.00"
        },
        "period": "monthly"
      }
    }
  ]
}

{
  "name": "Premium Bundle",
  "description": "A bundle including premium features and services.",
  "prices": [
    {
      "type": "unit",
      "productId": {
        "Type": "digital"
      },
      "billingInterval": "monthly",
      "unitPricingModel": {
        "pricePerUnit": {
          "value": "59.99"
        }
      },
      "tieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "pricePerUnit": {
              "value": "0.10"
            },
            "fixedFee": {
              "value": "5.00"
            }
          }
        ]
      },
      "fixedPricingModel": {
        "pricePerUnit": {
          "value": "24.99"
        },
        "units": 2,
        "total": {
          "value": "49.98"
        }
      },
      "graduatedPercentagePricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "fixedFee": {
              "value": "10.00"
            },
            "percentage": {
              "value": "15"
            }
          }
        ]
      },
      "prepaidFixedTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 50,
            "pricePerUnit": {
              "value": "0.15"
            },
            "fixedFee": {
              "value": "2.00"
            }
          }
        ],
        "units": 100
      },
      "prepaidTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 75,
            "pricePerUnit": {
              "value": "0.20"
            },
            "fixedFee": {
              "value": "3.00"
            }
          }
        ],
        "units": 50
      },
      "volumePercentagePricingModel": {
        "pricePerUnit": {
          "value": "0.05"
        },
        "percentage": {
          "value": "10"
        },
        "fixedFee": {
          "value": "5.00"
        }
      },
      "discount": {
        "discountType": "percentage",
        "amount": {
          "value": "10.00"
        },
        "periodLength": 6,
        "periodType": "months",
        "endDate": "2009-11-10T23:00:00Z"
      },
      "trialPeriodDays": 30,
      "minimumSpend": {
        "amount": {
          "value": "100.00"
        },
        "period": "monthly"
      },
      "maximumSpend": {
        "amount": {
          "value": "500.00"
        },
        "period": "monthly"
      }
    }
  ]
}

{
  "name": "Premium Bundle",
  "description": "A bundle including premium features and services.",
  "prices": [
    {
      "type": "unit",
      "productId": {
        "Type": "digital"
      },
      "billingInterval": "monthly",
      "unitPricingModel": {
        "pricePerUnit": {
          "value": "59.99"
        }
      },
      "tieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "pricePerUnit": {
              "value": "0.10"
            },
            "fixedFee": {
              "value": "5.00"
            }
          }
        ]
      },
      "fixedPricingModel": {
        "pricePerUnit": {
          "value": "24.99"
        },
        "units": 2,
        "total": {
          "value": "49.98"
        }
      },
      "graduatedPercentagePricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "fixedFee": {
              "value": "10.00"
            },
            "percentage": {
              "value": "15"
            }
          }
        ]
      },
      "prepaidFixedTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 50,
            "pricePerUnit": {
              "value": "0.15"
            },
            "fixedFee": {
              "value": "2.00"
            }
          }
        ],
        "units": 100
      },
      "prepaidTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 75,
            "pricePerUnit": {
              "value": "0.20"
            },
            "fixedFee": {
              "value": "3.00"
            }
          }
        ],
        "units": 50
      },
      "volumePercentagePricingModel": {
        "pricePerUnit": {
          "value": "0.05"
        },
        "percentage": {
          "value": "10"
        },
        "fixedFee": {
          "value": "5.00"
        }
      },
      "discount": {
        "discountType": "percentage",
        "amount": {
          "value": "10.00"
        },
        "periodLength": 6,
        "periodType": "months",
        "endDate": "2009-11-10T23:00:00Z"
      },
      "trialPeriodDays": 30,
      "minimumSpend": {
        "amount": {
          "value": "100.00"
        },
        "period": "monthly"
      },
      "maximumSpend": {
        "amount": {
          "value": "500.00"
        },
        "period": "monthly"
      }
    }
  ]
}

Request

name

string

required

The name of the bundle.

description

string

required

A brief description of the bundle.

prices

[]object

required

An array of pricing objects defining the available pricing models in the bundle.

Show Pricing Object Properties

type

string

required

The pricing model type.

productId

object

required

The product identifier associated with the pricing model.

Show Product ID Properties

Type

string

required

The type of the product.

billingInterval

string

required

The billing interval for the pricing model.

unitPricingModel

object

Details for the unit pricing model.

Show Unit Pricing Model Properties

pricePerUnit

object

required

The unit price details.

tieredPricingModel

object

Details for the tiered pricing model.

Show Tiered Pricing Model Properties

tiers

[]object

required

An array of tier definitions.

Show Tier Properties

minUnits

number

required

The minimum number of units for the tier.

maxUnits

number

required

The maximum number of units for the tier.

pricePerUnit

object

required

The unit price for this tier.

fixedFee

object

The fixed fee applied in this tier.

fixedPricingModel

object

Details for the fixed pricing model.

Show Fixed Pricing Model Properties

pricePerUnit

object

required

The unit price for the fixed pricing model.

units

number

required

The number of units for the fixed pricing model.

total

object

required

The total fixed price.

graduatedPercentagePricingModel

object

Details for the graduated percentage pricing model.

Show Graduated Percentage Pricing Model Properties

tiers

[]object

required

An array of tier definitions.

Show Tier Properties

minUnits

number

required

The minimum number of units for the tier.

maxUnits

number

required

The maximum number of units for the tier.

fixedFee

object

required

The fixed fee for this tier.

percentage

object

required

The percentage applied in this tier.

prepaidFixedTieredPricingModel

object

Details for the prepaid fixed tiered pricing model.

Show Prepaid Fixed Tiered Pricing Model Properties

tiers

[]object

required

An array of tier definitions.

Show Tier Properties

minUnits

number

required

The minimum number of units for the tier.

maxUnits

number

required

The maximum number of units for the tier.

pricePerUnit

object

required

The unit price for this tier.

fixedFee

object

required

The fixed fee for this tier.

units

number

required

The number of prepaid units.

prepaidTieredPricingModel

object

Details for the prepaid tiered pricing model.

Show Prepaid Tiered Pricing Model Properties

tiers

[]object

required

An array of tier definitions.

Show Tier Properties

minUnits

number

required

The minimum number of units for the tier.

maxUnits

number

required

The maximum number of units for the tier.

pricePerUnit

object

required

The unit price for this tier.

fixedFee

object

required

The fixed fee for this tier.

units

number

required

The number of prepaid units.

volumePercentagePricingModel

object

Details for the volume percentage pricing model.

Show Volume Percentage Pricing Model Properties

pricePerUnit

object

required

The unit price used in the volume calculation.

percentage

object

required

The percentage applied to the volume.

fixedFee

object

A fixed fee applied in addition to the percentage.

discount

object

Details for any discount applied to the pricing item.

Show Discount Properties

discountType

string

required

The type of discount.

amount

object

required

The discount amount.

periodLength

number

required

The duration of the discount in number of periods.

periodType

string

required

The type of period over which the discount applies.

endDate

datetime

required

The end date of the discount’s validity in ISO 8601 format.

trialPeriodDays

number

required

The number of trial days before the pricing model takes effect.

minimumSpend

object

The minimum spend requirement for the pricing item.

Show Minimum Spend Properties

amount

object

required

The minimum spend amount.

period

string

required

The period over which the minimum spend applies.

maximumSpend

object

The maximum spend allowed for the pricing item.

Show Maximum Spend Properties

amount

object

required

The maximum spend amount.

period

string

required

The period over which the maximum spend applies.

Response

{
  "name": "Premium Bundle",
  "description": "A bundle including premium features and services.",
  "prices": [
    {
      "type": "unit",
      "productId": {
        "Type": "digital"
      },
      "billingInterval": "monthly",
      "unitPricingModel": {
        "pricePerUnit": {
          "value": "59.99"
        }
      },
      "tieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "pricePerUnit": {
              "value": "0.10"
            },
            "fixedFee": {
              "value": "5.00"
            }
          }
        ]
      },
      "fixedPricingModel": {
        "pricePerUnit": {
          "value": "24.99"
        },
        "units": 2,
        "total": {
          "value": "49.98"
        }
      },
      "graduatedPercentagePricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "fixedFee": {
              "value": "10.00"
            },
            "percentage": {
              "value": "15"
            }
          }
        ]
      },
      "prepaidFixedTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 50,
            "pricePerUnit": {
              "value": "0.15"
            },
            "fixedFee": {
              "value": "2.00"
            }
          }
        ],
        "units": 100
      },
      "prepaidTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 75,
            "pricePerUnit": {
              "value": "0.20"
            },
            "fixedFee": {
              "value": "3.00"
            }
          }
        ],
        "units": 50
      },
      "volumePercentagePricingModel": {
        "pricePerUnit": {
          "value": "0.05"
        },
        "percentage": {
          "value": "10"
        },
        "fixedFee": {
          "value": "5.00"
        }
      },
      "discount": {
        "discountType": "percentage",
        "amount": {
          "value": "10.00"
        },
        "periodLength": 6,
        "periodType": "months",
        "endDate": "2009-11-10T23:00:00Z"
      },
      "trialPeriodDays": 30,
      "minimumSpend": {
        "amount": {
          "value": "100.00"
        },
        "period": "monthly"
      },
      "maximumSpend": {
        "amount": {
          "value": "500.00"
        },
        "period": "monthly"
      }
    }
  ]
}

items

[]Bundle

An array of bundle objects.

Show Bundle Properties

string

The unique identifier for the bundle.

name

string

The name of the bundle.

description

string

A brief description of the bundle.

prices

[]Price

An array of pricing objects included in the bundle.

Show Price Object Properties

string

The unique identifier for the pricing object.

type

string

The pricing model type.

product

Product

The product associated with the pricing object.

Show Product Properties

string

The unique identifier for the product.

name

string

The name of the product.

description

string

A brief description of the product.

billingFrequency

string

The billing frequency of the product.

paymentTerms

string

The payment terms for the product.

type

string

The pricing model type used by the product.

metricIds

[]string

The identifiers for the associated metrics.

billingInterval

string

The billing interval for the pricing.

fixedPricingModel

object

Details for the fixed pricing model.

tieredPricingModel

object

Details for the tiered pricing model.

unitPricingModel

object

Details for the unit pricing model.

createdAt

datetime

The timestamp when the pricing object was created.

updatedAt

datetime

The timestamp when the pricing object was last updated.

pageCount

number

The total number of pages available in the response.

limit

number

The maximum number of items returned per page.

Webhooks Update Bundle

{
  "name": "Premium Bundle",
  "description": "A bundle including premium features and services.",
  "prices": [
    {
      "type": "unit",
      "productId": {
        "Type": "digital"
      },
      "billingInterval": "monthly",
      "unitPricingModel": {
        "pricePerUnit": {
          "value": "59.99"
        }
      },
      "tieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "pricePerUnit": {
              "value": "0.10"
            },
            "fixedFee": {
              "value": "5.00"
            }
          }
        ]
      },
      "fixedPricingModel": {
        "pricePerUnit": {
          "value": "24.99"
        },
        "units": 2,
        "total": {
          "value": "49.98"
        }
      },
      "graduatedPercentagePricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "fixedFee": {
              "value": "10.00"
            },
            "percentage": {
              "value": "15"
            }
          }
        ]
      },
      "prepaidFixedTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 50,
            "pricePerUnit": {
              "value": "0.15"
            },
            "fixedFee": {
              "value": "2.00"
            }
          }
        ],
        "units": 100
      },
      "prepaidTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 75,
            "pricePerUnit": {
              "value": "0.20"
            },
            "fixedFee": {
              "value": "3.00"
            }
          }
        ],
        "units": 50
      },
      "volumePercentagePricingModel": {
        "pricePerUnit": {
          "value": "0.05"
        },
        "percentage": {
          "value": "10"
        },
        "fixedFee": {
          "value": "5.00"
        }
      },
      "discount": {
        "discountType": "percentage",
        "amount": {
          "value": "10.00"
        },
        "periodLength": 6,
        "periodType": "months",
        "endDate": "2009-11-10T23:00:00Z"
      },
      "trialPeriodDays": 30,
      "minimumSpend": {
        "amount": {
          "value": "100.00"
        },
        "period": "monthly"
      },
      "maximumSpend": {
        "amount": {
          "value": "500.00"
        },
        "period": "monthly"
      }
    }
  ]
}

{
  "name": "Premium Bundle",
  "description": "A bundle including premium features and services.",
  "prices": [
    {
      "type": "unit",
      "productId": {
        "Type": "digital"
      },
      "billingInterval": "monthly",
      "unitPricingModel": {
        "pricePerUnit": {
          "value": "59.99"
        }
      },
      "tieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "pricePerUnit": {
              "value": "0.10"
            },
            "fixedFee": {
              "value": "5.00"
            }
          }
        ]
      },
      "fixedPricingModel": {
        "pricePerUnit": {
          "value": "24.99"
        },
        "units": 2,
        "total": {
          "value": "49.98"
        }
      },
      "graduatedPercentagePricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 100,
            "fixedFee": {
              "value": "10.00"
            },
            "percentage": {
              "value": "15"
            }
          }
        ]
      },
      "prepaidFixedTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 50,
            "pricePerUnit": {
              "value": "0.15"
            },
            "fixedFee": {
              "value": "2.00"
            }
          }
        ],
        "units": 100
      },
      "prepaidTieredPricingModel": {
        "tiers": [
          {
            "minUnits": 1,
            "maxUnits": 75,
            "pricePerUnit": {
              "value": "0.20"
            },
            "fixedFee": {
              "value": "3.00"
            }
          }
        ],
        "units": 50
      },
      "volumePercentagePricingModel": {
        "pricePerUnit": {
          "value": "0.05"
        },
        "percentage": {
          "value": "10"
        },
        "fixedFee": {
          "value": "5.00"
        }
      },
      "discount": {
        "discountType": "percentage",
        "amount": {
          "value": "10.00"
        },
        "periodLength": 6,
        "periodType": "months",
        "endDate": "2009-11-10T23:00:00Z"
      },
      "trialPeriodDays": 30,
      "minimumSpend": {
        "amount": {
          "value": "100.00"
        },
        "period": "monthly"
      },
      "maximumSpend": {
        "amount": {
          "value": "500.00"
        },
        "period": "monthly"
      }
    }
  ]
}

API Reference

Bundles

Customers

Events & Usage Metering

Invoices

Plans

Products

Subscriptions

Subscription Versions

Request

Response

API Reference

Bundles

Customers

Events & Usage Metering

Invoices

Plans

Products

Subscriptions

Subscription Versions

​Request

​Response

Request

Response