Create invoice discount
Creates a manual discount on an invoice. The discount can target the whole invoice, a line item group, or a single line item (via targetIdempotencyKey).
Authorizations
API Key Authentication.
Path Parameters
The unique identifier of the invoice the discount belongs to.
Body
Schema representing a discount on an invoice, on one of its line item groups, or on one of its line items. Only active discounts (see isActive) affect the invoice totals.
What the discount applies to: the whole invoice, one line item group, or one line item.
invoice, line_item_group, line_item The idempotency key of the targeted invoice, line item group, or line item, matching the target field.
How amount is interpreted: fixed subtracts a monetary amount; percentage subtracts a percentage of the targeted amount.
fixed, percentage Display text of the discount as it appears on the invoice.
1Value of the discount, as a positive integer: whole cents when method is fixed; basis points when method is percentage (1 basis point = 0.01%; maximum 10000 = 100%).
x >= 1Must be a multiple of 1Response
Schema representing a discount on an invoice, on one of its line item groups, or on one of its line items. Only active discounts (see isActive) affect the invoice totals.
The unique identifier of the discount in our system.
What the discount applies to: the whole invoice, one line item group, or one line item.
invoice, line_item_group, line_item The idempotency key of the targeted invoice, line item group, or line item, matching the target field.
How amount is interpreted: fixed subtracts a monetary amount; percentage subtracts a percentage of the targeted amount.
fixed, percentage Why the discount exists: manual_discount (created by a user or through the API), contract_proration or plan_instance_proration (generated to prorate a partial period), or contract_recurring (generated from a recurring discount configured on the contract).
manual_discount, contract_proration, contract_recurring, plan_instance_proration Display text of the discount as it appears on the invoice.
1Value of the discount, as a positive integer: whole cents when method is fixed; basis points when method is percentage (1 basis point = 0.01%; maximum 10000 = 100%).
x >= 1Must be a multiple of 1Whether the discount is currently applied to the invoice totals. Inactive discounts are kept for history but have no effect.