POST /exports/item_prices

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Valid values:

• "all-disabled"

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

skip all actions to be done on the events

Valid values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

skip only emails

Valid values:

• "all-disabled"

optional, string filterFilter item prices based on their currency_code.Supported operators : is, is_not, starts_with, in, not_inExample → currency_code[is] = "USD"

optional, string filterThe unique ID of the business entity of this item_price. Learn more about all the scenarios before using this filter. Supported operators : is, is_presentExample → business_entity_id[is_present] = "true"

null

Valid values:

• "false"
• "true"

Parameters for item_price

Filter item prices based on their [id](#).

Filter item prices based on their trial_period_unit.

* `day` - A period of 24 hours. * `month` - A period of 1 calendar month.

Valid values:

• "month"
• "day"

* `day` - A period of 24 hours. * `month` - A period of 1 calendar month.

Valid values:

• "month"
• "day"

Filter item prices based on their period_unit.

* `day` - A period of 24 hours. * `week` - A period of 7 days. * `month` - A period of 1 calendar month. * `year` - A period of 1 calendar year.

Valid values:

• "month"
• "day"
• "week"
• "year"

* `day` - A period of 24 hours. * `week` - A period of 7 days. * `month` - A period of 1 calendar month. * `year` - A period of 1 calendar year.

Valid values:

• "month"
• "day"
• "week"
• "year"

Filter item prices based on their pricing_model.

* `flat_fee` - A fixed price that is not quantity-based. * `per_unit` - A fixed price per unit quantity. * `tiered` - The per unit price is based on the tier that the total quantity falls in. * `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. * `stairstep` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.

Valid values:

• "tiered"
• "per_unit"
• "stairstep"
• "flat_fee"
• "volume"

* `flat_fee` - A fixed price that is not quantity-based. * `per_unit` - A fixed price per unit quantity. * `tiered` - The per unit price is based on the tier that the total quantity falls in. * `volume` - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. * `stairstep` - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.

Valid values:

• "tiered"
• "per_unit"
• "stairstep"
• "flat_fee"
• "volume"

Filter item prices based on their names.

The subscription channel this object originated from and is maintained in.

* `web` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. * `app_store` - The object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.

Valid values:

• "web"
• "play_store"
• "app_store"

* `web` - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. * `app_store` - The object data is synchronized with data from in-app subscription(s) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed.
In-App Subscriptions is currently in early access. Contact eap@chargebee.com for more information.

Valid values:

• "web"
• "play_store"
• "app_store"

Filter item prices based on their price_variant_id.

Filter item prices based on their period.

Filter item prices based on their trial_period.

Filter item prices based on their status.

• active - The item price can be used in subscriptions.
• archived - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.
• deleted - Indicates that the item price has been deleted. The id and name can be reused.

Valid values:

• "active"
• "deleted"
• "archived"

• active - The item price can be used in subscriptions.
• archived - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price.
• deleted - Indicates that the item price has been deleted. The id and name can be reused.

Valid values:

• "active"
• "deleted"
• "archived"

Filter item prices based on their item_id.

Filter item prices based on their updated_at.

optional, boolean filter

Default value is true . To exclude site-level resources in specific cases, set this parameter to false.

Valid values:

• "false"
• "true"

optional, enumerated string filterFilter item prices based on item_type. Possible values are : plan, addon, charge.Supported operators : is, is_not, in, not_inExample → item_type[is_not] = "plan"

* `plan` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. * `addon` - A recurring component that can be added to a subscription in addition to its plan. * `charge` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer directly without being applied to a subscription.

Valid values:

• "plan"
• "charge"
• "addon"

* `plan` - An essential component of a subscription. Every subscription has exactly one plan. It has a recurring charge and its period defines the billing period of the subscription. * `addon` - A recurring component that can be added to a subscription in addition to its plan. * `charge` - A non-recurring component that can be added to a subscription in addition to its plan. An charge can also be applied to a customer directly without being applied to a subscription.

Valid values:

• "plan"
• "charge"
• "addon"

optional, string filterFilter item prices based on item_family_id.Supported operators : is, is_not, starts_with, in, not_inExample → item_family_id[is] = "Acme"