POST
/
price-plans
curl -X POST \
 /price-plans \
 --header "Content-Type: application/json" \
 --header "Authorization: Bearer <token>" \
 --data '{
    "internalName": "Exclusive pricing for partners.",
    "customer": "https:\/\/example.com\/",
    "applyTrial": "1",
    "payInAdvance": "1",
    "proRata": "",
    "currencyCode": [],
    "price": []
}'
{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "internalName": "Exclusive pricing for partners.",
  "status": "<any>",
  "salesChannel": {},
  "type": "<any>",
  "applyTrial": true,
  "payInAdvance": true,
  "proRata": true,
  "freeUnits": {},
  "billingInterval": "1M",
  "showPricePerInterval": "1M",
  "currencyCode": {},
  "price": {
    "amount": 123,
    "createdAt": "2021-01-01T00:00:00+00:00",
    "updatedAt": "2021-01-01T00:00:00+00:00",
    "tenantId": "<string>"
  },
  "custom": true,
  "charge": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "productSetOption": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "product": "<any>",
  "customer": "<any>",
  "inUse": true,
  "checkoutLinkIds": [
    "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"
  ]
}

Authorizations

​
Authorization
string
header
required

Value for the Authorization header parameter.

Body

The new PricePlan resource
​
product
any
required

The product this price plan belongs to.

​
type
any
required

The type of the charge. This defines how the price is calculated.

Possible values:

  • flat_fee: A flat fee is charged, e.g. 10€ per month independent of the number of units.
  • volume: A volume based price is charged, e.g. 10€ for the first 10 units and 9€ for all units when the number of units is above 10. Useful for volume discounts.
  • percentage: A percentage of the total price is charged, e.g. 10% of the total price multiplied by the number of units. Useful for provisions.
  • per_unit: A price per unit is charged, e.g. 10€ per unit per billing interval. Useful for per seat based pricing.
  • tiered: A tiered price is charged. E.g. 10€ per unit for the first 10 units, 9€ per unit for the next 10 units and 8€ per unit for all units above 20.
  • stair_step: A stair step price is charged. E.g. 10€ per unit for the first 10 units, 9€ per unit for all units above 10.
​
currencyCode
object
required

The currency of the price

​
price
object
required

The price in the defined billing interval.

​
internalName
string | null

The internal name of the price plan.

Required string length: 3 - 255
Example:

"Exclusive pricing for partners."

​
customer
string | null

This price is only available for a specific customer. If this is set, the price is only available for the customer with the given ID. All other price plans will be ignored.

Example:

"https://example.com/"

​
applyTrial
boolean
default:true

If this is set to true, the price plan can be applied on a trial. If the product is in trial, and this is false, the price will be charged on subscription start, otherwise after trial.

Example:

true

​
payInAdvance
boolean | null
default:true

If this is set to true, the price will be charged in advance. If this is false, the price will be charged at the end of the billing interval.

Example:

true

​
proRata
boolean

If this is set to true, the price will be charged prorated when a partial billing interval is billed. This applies to measurements of type "recurring" or non-one-time billing intervals. For other measurements this parameter will be ignored.

​
freeUnits
object | null

The amount of free units. If null, no free units are available. Free units will be applied before passed to the price calculation and are available prorated. If the customer does not uses the free units during a billing period, they are not carried over to the next billing period. If the customer cancels the subscription before ending the billing period, the free units are only available prorated for the remaining billing period.

Example: You offer 2400 free units for 12 months and your price has a billing interval for 1 month. The customer cancels after 6 months. Only 1200 free units are available.

A price plan for a recurring product cannot have free units. Use a metered product instead.

A price plan related to a product of type charge cannot have free units.

​
billingInterval
object | null

The billing interval of the price plan. If null, this is a one-time charge. Billing intervals of null cannot be prorated.

Example:

"1M"

​
showPricePerInterval
object | null

Display the billed price per interval in customerfront or invoices. If null, the price will be shown per billing interval. Currently only available for billing intervals of months, years. Currently only allowed to show price per month (1M)

Example:

"1M"

Response

201
application/json
PricePlan resource created
​
type
any
required

The type of the charge. This defines how the price is calculated.

Possible values:

  • flat_fee: A flat fee is charged, e.g. 10€ per month independent of the number of units.
  • volume: A volume based price is charged, e.g. 10€ for the first 10 units and 9€ for all units when the number of units is above 10. Useful for volume discounts.
  • percentage: A percentage of the total price is charged, e.g. 10% of the total price multiplied by the number of units. Useful for provisions.
  • per_unit: A price per unit is charged, e.g. 10€ per unit per billing interval. Useful for per seat based pricing.
  • tiered: A tiered price is charged. E.g. 10€ per unit for the first 10 units, 9€ per unit for the next 10 units and 8€ per unit for all units above 20.
  • stair_step: A stair step price is charged. E.g. 10€ per unit for the first 10 units, 9€ per unit for all units above 10.
​
currencyCode
object
required

The currency of the price

​
price
object
required

The price in the defined billing interval.

​
id
string

The unique identifier of the price plan.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

​
internalName
string | null

The internal name of the price plan.

Required string length: 3 - 255
Example:

"Exclusive pricing for partners."

​
status
any

The status of the price plan.

Possible values:

  • active: The price is active and can be used.
  • archived: The price is archived and cannot be used anymore. It will be not shown in any lists until explicitly requested.
​
salesChannel
object | null

This price is only available for a specific sales channel. If this is set, the price is only available for the sales channel with the given ID. All other price plans will be ignored.

​
applyTrial
boolean
default:true

If this is set to true, the price plan can be applied on a trial. If the product is in trial, and this is false, the price will be charged on subscription start, otherwise after trial.

Example:

true

​
payInAdvance
boolean | null
default:true

If this is set to true, the price will be charged in advance. If this is false, the price will be charged at the end of the billing interval.

Example:

true

​
proRata
boolean

If this is set to true, the price will be charged prorated when a partial billing interval is billed. This applies to measurements of type "recurring" or non-one-time billing intervals. For other measurements this parameter will be ignored.

​
freeUnits
object | null

The amount of free units. If null, no free units are available. Free units will be applied before passed to the price calculation and are available prorated. If the customer does not uses the free units during a billing period, they are not carried over to the next billing period. If the customer cancels the subscription before ending the billing period, the free units are only available prorated for the remaining billing period.

Example: You offer 2400 free units for 12 months and your price has a billing interval for 1 month. The customer cancels after 6 months. Only 1200 free units are available.

A price plan for a recurring product cannot have free units. Use a metered product instead.

A price plan related to a product of type charge cannot have free units.

​
billingInterval
object | null

The billing interval of the price plan. If null, this is a one-time charge. Billing intervals of null cannot be prorated.

Example:

"1M"

​
showPricePerInterval
object | null

Display the billed price per interval in customerfront or invoices. If null, the price will be shown per billing interval. Currently only available for billing intervals of months, years. Currently only allowed to show price per month (1M)

Example:

"1M"

​
custom
boolean

If this price plan is a custom price plan. A price plan is custom if it is defined specific for a plan addon, plan charge, customer or sales channel.

Example:

true

​
charge
string

The charge related to this price plan.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

​
productSetOption
string

The product set option related to this price plan.

Example:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

​
product
any

The product this price plan belongs to.

​
customer
any

The customer this price plan belongs to.

​
inUse
boolean

If this price plan is in use.

Example:

true

​
checkoutLinkIds
string[]

The checkout link IDs related to this price plan.

Example:
["ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"]