HubSpot: Payment links schemas

← Payment links operations · All schemas

Create a payment link — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
acceptedPaymentMethods	array	Required within parent	An array of accepted payment methods for the payment link. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.
acceptedPaymentMethods[]	string	Each item	One of: CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA
additionalFormFields	array	Required within parent	An array of PaymentLinkFormField objects representing additional form fields to be included in the payment link.
additionalFormFields[]	Model	Each item	Expand Create a payment link — request body — body additional Form Fields item
automatedSalesTaxEnabled	boolean	Optional	A boolean indicating whether automated sales tax is enabled.
businessUnitId	string	Optional	A string representing the business unit ID associated with the payment link.
collectFullBillingAddress	boolean	Optional	A boolean indicating whether to collect the full billing address during checkout.
collectShippingAddress	boolean	Optional	A boolean indicating whether the shipping address should be collected during checkout.
createContractOnPurchase	boolean	Optional	A boolean indicating whether to create a contract upon purchase.
currencyCode	string	Required within parent	The currency code for the payment, represented as a string.
dealConfigurations	Model	Optional	Expand Create a payment link — response body — deal Configurations
descriptionHtml	string	Optional	A string containing the HTML description of the payment link.
discount	Model	Optional	Expand Create a payment link — request body — body discount
discountCodeEnabled	boolean	Optional	A boolean indicating whether discount codes are enabled for the payment link.
discountObjectId	string	Optional	A string representing the object ID of a discount associated with the payment link.
domainId	string	Optional	The domain ID associated with the payment link, represented as a string.
enableDefaultCheckoutFees	boolean	Required within parent	A boolean indicating whether default checkout fees are enabled.
expirationSettings	Model	Optional	Expand Create a payment link — request body — body expiration Settings
feeObjectIds	array	Required within parent	An array of strings representing the IDs of fee objects associated with the payment link.
feeObjectIds[]	string	Each item
fees	array	Required within parent	An array of FeeRequest objects, representing the fees to be applied to the payment link.
fees[]	Model	Each item	Expand Create a payment link — request body — body fees item
includeEmailInSuccessRedirect	boolean	Required within parent	A boolean indicating whether to include the email in the success redirect URL.
isOneTimeUseEnabled	boolean	Required within parent	A boolean indicating whether the payment link is enabled for one-time use.
lineItemObjectIds	array	Required within parent	An array of line item object IDs associated with the payment link, each represented as a string.
lineItemObjectIds[]	string	Each item
lineItems	array	Required within parent	An array of line items, which can be custom, from a product, or cloned, as defined by their respective schemas.
lineItems[]	JSON	Each item
lineItems[] (oneOf 1)	Model	Alternative	Expand Create a payment link — request body — body / lineItems / item / mode: CUSTOM
lineItems[] (oneOf 2)	Model	Alternative	Expand Create a payment link — request body — body / lineItems / item / mode: FROM PRODUCT
lineItems[] (oneOf 3)	Model	Alternative	Expand Create a payment link — request body — body / lineItems / item / mode: CLONE
paymentLinkName	string	Required within parent	The name of the payment link. It is a string value.
state	string	Required within parent	The state of the payment link, represented as a string. Valid values are 'ON' and 'OFF'. One of: OFF, ON
storePaymentMethodAtCheckout	boolean	Optional	A boolean indicating whether to store the payment method at checkout.
successUrl	string	Optional	A string that defines the URL to redirect to upon successful payment.
taxObjectIds	array	Required within parent	An array of string IDs representing tax objects associated with the payment link.
taxObjectIds[]	string	Each item
taxes	array	Required within parent	An array of TaxRequest objects, each representing a tax associated with the payment link.
taxes[]	Model	Each item	Expand Create a payment link — request body — body taxes item

Referenced models: Create a payment link — response body — deal Configurations, Create a payment link — request body — body discount, Create a payment link — request body — body expiration Settings, Create a payment link — request body — body fees item, Create a payment link — request body — body / lineItems / item / mode: CLONE, Create a payment link — request body — body / lineItems / item / mode: CUSTOM, Create a payment link — request body — body / lineItems / item / mode: FROM PRODUCT, Create a payment link — request body — body additional Form Fields item, Create a payment link — request body — body taxes item

Create a payment link — request body — body / lineItems / item / mode: CLONE

Field	Type	Presence	Description and constraints
$	object	Root
allowBuyerSelectedQuantity	object	Required within parent	An object indicating whether the buyer can select the quantity of the line item.
billingCycleAnchorDate	object	Required within parent	An object representing the anchor date for the billing cycle of the line item.
billingStartDelayDays	object	Required within parent	An object representing the number of days to delay the start of billing for the line item.
billingStartDelayMonths	object	Required within parent	An object representing the number of months to delay the start of billing for the line item.
buyerSelectedQuantityMax	object	Required within parent	An object representing the maximum quantity the buyer can select for the line item.
buyerSelectedQuantityMin	object	Required within parent	An object representing the minimum quantity the buyer can select for the line item.
description	object	Required within parent	An object representing the description of the line item.
discount	object	Required within parent	An object representing the discount applied to the line item.
discountPercentage	object	Required within parent	An object representing the discount percentage applied to the line item.
externalId	object	Required within parent	An object representing an external identifier for the line item.
images	object	Required within parent	An object representing the images associated with the line item.
isEditablePrice	object	Required within parent	An object indicating whether the price of the line item is editable.
isOptional	object	Required within parent	An object indicating whether the line item is optional.
lineItemCurrencyCode	object	Required within parent	An object representing the currency code for the line item.
mode	string	Required within parent	A string indicating the mode of the line item creation, which is 'CLONE' for this component. Default: CLONE One of: CLONE
name	object	Required within parent	An object representing the name of the line item.
positionOnQuote	object	Required within parent	An object representing the position of the line item on the quote.
priceBookId	object	Required within parent	An object representing the price book ID associated with the line item.
pricing	object	Required within parent	An object representing the pricing details of the line item.
productType	object	Required within parent	An object representing the type of product for the line item.
quantity	object	Required within parent	An object representing the quantity of the line item.
recurringBillingEndDate	object	Required within parent	An object representing the end date for recurring billing of the line item.
recurringBillingFrequency	object	Required within parent	An object representing the frequency of recurring billing for the line item.
recurringBillingPeriod	object	Required within parent	An object representing the billing period for recurring billing of the line item.
recurringBillingStartDate	object	Required within parent	An object representing the start date for recurring billing of the line item.
richTextDescription	object	Required within parent	An object representing the rich text description of the line item.
sku	object	Required within parent	An object representing the stock keeping unit (SKU) of the line item.
sourceLineItemId	string	Required within parent	A string representing the ID of the source line item being cloned.
taxCategory	object	Required within parent	An object representing the tax category of the line item.
taxRateGroupId	object	Required within parent	An object representing the tax rate group ID for the line item.
variantId	object	Required within parent	An object representing the variant ID of the line item.

Create a payment link — request body — body / lineItems / item / mode: CUSTOM

Field	Type	Presence	Description and constraints
$	object	Root
allowBuyerSelectedQuantity	boolean	Optional	A boolean specifying if the buyer can select the quantity of the line item.
billingCycleAnchorDate	string	Optional	A string in date format representing the anchor date for the billing cycle. Format: date
billingStartDelayDays	integer	Optional	An integer indicating the number of days to delay the start of billing. Format: int32
billingStartDelayMonths	integer	Optional	An integer indicating the number of months to delay the start of billing. Format: int32
buyerSelectedQuantityMax	number	Optional	A number indicating the maximum quantity the buyer can select.
buyerSelectedQuantityMin	number	Optional	A number indicating the minimum quantity the buyer can select.
description	string	Optional	A string providing a description of the line item.
discount	number	Optional	A number representing the discount applied to the line item.
discountPercentage	number	Optional	A number indicating the discount percentage applied to the line item.
externalId	string	Optional	A string representing an external identifier for the line item.
images	string	Optional	A string containing URLs or identifiers for images associated with the line item.
isEditablePrice	boolean	Optional	A boolean indicating whether the price of the line item is editable.
isOptional	boolean	Optional	A boolean indicating whether the line item is optional.
lineItemCurrencyCode	string	Optional	A string representing the currency code for the line item.
mode	string	Required within parent	A string that indicates the mode of the line item, which is set to 'CUSTOM'. Default: CUSTOM One of: CUSTOM
name	string	Required within parent	A string representing the name of the line item.
positionOnQuote	integer	Optional	An integer indicating the position of the line item on a quote. Format: int32
priceBookId	string	Optional	A string that identifies the price book associated with the line item.
pricing	Model	Required within parent	Expand Create a payment link — request body — body / lineItems / item / mode: CUSTOM pricing
productId	string	Optional	A string that identifies the product associated with the line item.
productType	string	Optional	A string indicating the type of product for the line item.
quantity	number	Required within parent	A number indicating the quantity of the line item.
recurringBillingEndDate	string	Optional	A string in date format indicating the end date of recurring billing. Format: date
recurringBillingFrequency	string	Optional	A string specifying the frequency of recurring billing. Valid values include 'ANNUALLY', 'BIWEEKLY', 'MONTHLY', 'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS', 'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY', and 'WEEKLY'. One of: ANNUALLY, BIWEEKLY, MONTHLY, PER_FIVE_YEARS, PER_FOUR_YEARS, PER_SIX_MONTHS, PER_THREE_YEARS, PER_TWO_YEARS, QUARTERLY, WEEKLY
recurringBillingPeriod	string	Optional	A string representing the period of recurring billing.
recurringBillingStartDate	string	Optional	A string in date format indicating the start date of recurring billing. Format: date
richTextDescription	string	Optional	A string containing a rich text description of the line item.
sku	string	Optional	A string representing the stock keeping unit (SKU) of the line item.
taxCategory	string	Optional	A string representing the tax category of the line item.
taxRateGroupId	string	Optional	The tax rate group ID associated with the line item as a string.
variantId	string	Optional	A string representing the variant identifier of the product.

Referenced models: Create a payment link — request body — body / lineItems / item / mode: CUSTOM pricing

Create a payment link — request body — body / lineItems / item / mode: CUSTOM pricing

Field	Type	Presence	Description and constraints
$	object	Root
prices	array	Required within parent	An array of PriceUpdateEntry objects, each specifying the price details such as currency code and price amount for different quantities.
prices[]	Model	Each item	Expand Create a payment link — request body — body / lineItems / item / mode: CUSTOM pricing prices item
pricingModel	string	Required within parent	The pricing model applied to the line item. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'. One of: FLAT, GRADUATED, STAIRSTEP, VOLUME

Referenced models: Create a payment link — request body — body / lineItems / item / mode: CUSTOM pricing prices item

Create a payment link — request body — body / lineItems / item / mode: CUSTOM pricing prices item

Field	Type	Presence	Description and constraints
$	object	Root
currencyCode	string	Required within parent	The currency code in which the price is specified, represented as a string.
maxQuantity	integer	Optional	The maximum quantity for which this price is applicable, represented as a string. Format: int32
price	object	Required within parent	An object representing the price details. The specific structure of this object is not detailed in the specification.

Create a payment link — request body — body / lineItems / item / mode: FROM PRODUCT

Field	Type	Presence	Description and constraints
$	object	Root
allowBuyerSelectedQuantity	object	Required within parent	An object indicating whether the buyer can select the quantity of the product.
billingCycleAnchorDate	object	Required within parent	An object representing the anchor date for the billing cycle.
billingStartDelayDays	object	Required within parent	An object representing the number of days to delay the start of billing.
billingStartDelayMonths	object	Required within parent	An object representing the number of months to delay the start of billing.
buyerSelectedQuantityMax	object	Required within parent	An object representing the maximum quantity the buyer can select.
buyerSelectedQuantityMin	object	Required within parent	An object representing the minimum quantity the buyer can select.
description	object	Required within parent	An object representing the description of the product associated with the line item.
discount	object	Required within parent	An object representing any discount applied to the line item.
discountPercentage	object	Required within parent	An object representing the percentage discount applied to the line item.
externalId	object	Required within parent	An object representing an external identifier for the line item.
images	object	Required within parent	An object representing images associated with the product.
isEditablePrice	object	Required within parent	An object indicating whether the price of the line item is editable.
isOptional	object	Required within parent	An object indicating whether the line item is optional.
lineItemCurrencyCode	object	Required within parent	An object representing the currency code for the line item.
mode	string	Required within parent	A string indicating the mode of the line item creation. The default and only valid value is 'FROM_PRODUCT'. Default: FROM_PRODUCT One of: FROM_PRODUCT
name	object	Required within parent	An object representing the name of the product associated with the line item.
positionOnQuote	object	Required within parent	An object representing the position of the line item on a quote.
priceBookId	object	Required within parent	An object representing the ID of the price book associated with the product.
pricing	object	Required within parent	An object representing the pricing details of the line item.
productId	string	Required within parent	A string representing the unique identifier of the product.
productType	object	Required within parent	An object representing the type of product.
quantity	object	Required within parent	An object representing the quantity of the product to be included in the line item.
recurringBillingEndDate	object	Required within parent	An object representing the end date of the recurring billing cycle.
recurringBillingFrequency	object	Required within parent	An object representing the frequency of recurring billing for the line item.
recurringBillingPeriod	object	Required within parent	An object representing the period of the recurring billing cycle.
recurringBillingStartDate	object	Required within parent	An object representing the start date of the recurring billing cycle.
richTextDescription	object	Required within parent	An object representing a rich text description of the product associated with the line item.
sku	object	Required within parent	An object representing the stock keeping unit (SKU) of the product.
taxCategory	object	Required within parent	An object representing the tax category of the product.
taxRateGroupId	object	Required within parent	An object representing the tax rate group ID for the product.
variantId	object	Required within parent	An object representing the variant ID of the product.

Create a payment link — request body — body additional Form Fields item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A description of the form field, providing additional context or instructions, represented as a string.
isRequired	boolean	Required within parent	A boolean indicating whether this form field is required to be filled out.
label	string	Required within parent	The label for the form field, which is displayed to users, represented as a string.
objectType	string	Required within parent	The type of object this form field is associated with, represented as a string. Valid values include 'CONTACT' and 'COMPANY'. One of: COMPANY, CONTACT
options	array	Required within parent	An array of options available for this form field, each represented as a FormFieldOption object.
options[]	Model	Each item	Expand Create a payment link — response body — additional Form Fields item options item
propertyName	string	Required within parent	The name of the property associated with this form field, represented as a string.

Referenced models: Create a payment link — response body — additional Form Fields item options item

Create a payment link — request body — body discount

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Required within parent	A descriptive label for the discount. This is a string.
value	number	Required within parent	The numerical value of the discount to be applied. This is a number.
valueType	string	Required within parent	The type of discount value, which can either be 'FIXED' or 'PERCENT'. One of: FIXED, PERCENT

Create a payment link — request body — body expiration Settings

Field	Type	Presence	Description and constraints
$	object	Root
expirationDate	string	Optional	The date and time when the payment link will expire, in ISO 8601 format. Format: date-time
maxPurchases	integer	Optional	The maximum number of purchases allowed for this payment link. It is an integer value. Format: int32

Create a payment link — request body — body fees item

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Required within parent	A descriptive label for the fee, represented as a string.
value	number	Required within parent	The numerical value of the fee. This is a number representing either a fixed amount or a percentage, depending on the valueType.
valueType	string	Required within parent	The type of the fee value, indicating whether it is a fixed amount or a percentage. Valid values include 'FIXED' and 'PERCENT'. One of: FIXED, PERCENT

Create a payment link — request body — body taxes item

Field	Type	Presence	Description and constraints
$	object	Root
label	string	Required within parent	A string that provides a label or description for the tax, used for identification or display purposes.
value	number	Required within parent	The numeric value of the tax. It represents the amount or percentage, depending on the valueType.
valueType	string	Required within parent	A string indicating the type of tax value. Valid values are 'FIXED' for a fixed amount and 'PERCENT' for a percentage-based tax. One of: FIXED, PERCENT

Create a payment link — response body

Field	Type	Presence	Description and constraints
$	object	Root
acceptedPaymentMethods	array	Required within parent	An array of accepted payment methods for the payment link. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.
acceptedPaymentMethods[]	string	Each item	Known values: CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA
additionalFormFields	array	Required within parent	An array of additional form fields included in the payment link.
additionalFormFields[]	Model	Each item	Expand Create a payment link — response body — additional Form Fields item
archived	boolean	Required within parent	A boolean indicating whether the payment link is archived.
archivedAt	string	Optional	The date and time when the payment link was archived, in ISO 8601 format. Format: date-time
automatedSalesTaxEnabled	boolean	Required within parent	A boolean indicating whether automated sales tax is enabled for the payment link.
businessUnitId	string	Optional	The business unit ID associated with the payment link, represented as a string.
checkoutFeeIds	array	Required within parent	An array of checkout fee IDs associated with the payment link.
checkoutFeeIds[]	string	Each item
collectFullBillingAddress	boolean	Required within parent	A boolean indicating whether to collect the full billing address during checkout.
collectShippingAddress	boolean	Required within parent	A boolean indicating whether to collect the shipping address during checkout.
completedPurchaseCount	JSON	Required within parent
completedPurchaseCount (anyOf 1)	integer	Alternative	The number of completed purchases made through this payment link. Format: int32
completedPurchaseCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createContractOnPurchase	boolean	Required within parent	A boolean indicating whether a contract should be created upon purchase.
createdAt	string	Optional	The date and time when the payment link was created, in ISO 8601 format. Format: date-time
currencyCode	string	Required within parent	The currency code for the payment link, represented as a string.
dealConfigurations	Model	Optional	Expand Create a payment link — response body — deal Configurations
descriptionHtml	string	Optional	The HTML description of the payment link, represented as a string.
discountCodeEnabled	boolean	Required within parent	A boolean indicating whether discount codes are enabled for the payment link.
discounts	array	Required within parent	An array of discount objects associated with the payment link.
discounts[]	Model	Each item	Expand Create a payment link — response body — discounts item
domainId	string	Optional	The domain ID associated with the payment link, represented as a string.
expirationSettings	Model	Optional	Expand Create a payment link — response body — expiration Settings
fees	array	Required within parent	An array of fee objects associated with the payment link.
fees[]	Model	Each item	Expand Create a payment link — response body — fees item
formGuid	string	Required within parent	The form GUID associated with the payment link, represented as a string.
id	string	Required within parent	The unique identifier for the payment link, represented as a string.
includeEmailInSuccessRedirect	boolean	Required within parent	A boolean indicating whether to include the email in the success redirect URL.
isOneTimeUseEnabled	boolean	Required within parent	A boolean indicating whether the payment link is enabled for one-time use.
lineItems	array	Required within parent	An array of line items associated with the payment link.
lineItems[]	Model	Each item	Expand Create a payment link — response body — line Items item
paymentLinkName	string	Required within parent	The name of the payment link, represented as a string.
paymentLinkUrl	string	Required within parent	The URL of the payment link, represented as a string.
state	string	Required within parent	The current state of the payment link, represented as a string. Valid values include 'ON' and 'OFF'. Known values: OFF, ON
storePaymentMethodAtCheckout	boolean	Required within parent	A boolean indicating whether to store the payment method at checkout.
successUrl	string	Optional	The URL to redirect to upon successful payment, represented as a string.
taxes	array	Required within parent	An array of tax objects associated with the payment link.
taxes[]	Model	Each item	Expand Create a payment link — response body — taxes item
updatedAt	string	Optional	The date and time when the payment link was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create a payment link — response body — deal Configurations, Create a payment link — response body — discounts item, Create a payment link — response body — expiration Settings, Create a payment link — response body — fees item, Create a payment link — response body — line Items item, Create a payment link — response body — additional Form Fields item, Create a payment link — response body — taxes item

Create a payment link — response body — additional Form Fields item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A description of the form field, providing additional context or instructions, represented as a string.
isRequired	boolean	Required within parent	A boolean indicating whether this form field is required to be filled out.
label	string	Required within parent	The label for the form field, which is displayed to users, represented as a string.
objectType	string	Required within parent	The type of object this form field is associated with, represented as a string. Valid values include 'CONTACT' and 'COMPANY'. Known values: COMPANY, CONTACT
options	array	Required within parent	An array of options available for this form field, each represented as a FormFieldOption object.
options[]	Model	Each item	Expand Create a payment link — response body — additional Form Fields item options item
propertyName	string	Required within parent	The name of the property associated with this form field, represented as a string.

Referenced models: Create a payment link — response body — additional Form Fields item options item

Create a payment link — response body — additional Form Fields item options item

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	A string providing additional information or context about the form field option.
label	string	Required within parent	A string representing the display name of the form field option.
value	string	Required within parent	A string representing the underlying value associated with the form field option.

Create a payment link — response body — deal Configurations

Field	Type	Presence	Description and constraints
$	object	Root
createNewDealOnPurchase	boolean	Required within parent	A boolean indicating whether a new deal should be created in HubSpot upon a purchase. Required field.
pipelineStageId	string	Optional	The identifier for the pipeline stage where the new deal will be placed. This is a string value.

Create a payment link — response body — discounts item

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	Indicates whether this discount has been archived. A boolean value.
archivedAt	string	Optional	The date and time when this discount was archived, in ISO 8601 format. Format: date-time
createdAt	string	Optional	The date and time when this discount was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this discount.
label	string	Optional	A descriptive label for the discount.
updatedAt	string	Optional	The date and time when this discount was last updated, in ISO 8601 format. Format: date-time
value	JSON	Optional
value (anyOf 1)	number	Alternative	The numerical value of the discount.
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valueType	string	Optional	The type of discount value, which can be either 'FIXED' or 'PERCENT'. Known values: FIXED, PERCENT

Create a payment link — response body — expiration Settings

Field	Type	Presence	Description and constraints
$	object	Root
expirationDate	string	Optional	The date and time when the payment link will expire, in ISO 8601 format. Format: date-time
maxPurchases	JSON	Optional
maxPurchases (anyOf 1)	integer	Alternative	The maximum number of purchases allowed for this payment link. It is an integer value. Format: int32
maxPurchases (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a payment link — response body — fees item

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	Indicates whether this fee has been archived. A boolean value.
archivedAt	string	Optional	The date and time when this fee was archived, in ISO 8601 format. Format: date-time
createdAt	string	Optional	The date and time when this fee was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this fee.
label	string	Optional	A descriptive label for the fee.
updatedAt	string	Optional	The date and time when this fee was last updated, in ISO 8601 format. Format: date-time
value	JSON	Optional
value (anyOf 1)	number	Alternative	The monetary value of the fee. A number representing the fee amount.
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valueType	string	Optional	The type of value for the fee, which can be either 'FIXED' or 'PERCENT'. Known values: FIXED, PERCENT

Create a payment link — response body — line Items item

Field	Type	Presence	Description and constraints
$	object	Root
acv	JSON	Optional
acv (anyOf 1)	number	Alternative	The annual contract value for the line item.
acv (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
allowBuyerSelectedQuantity	boolean	Optional	Indicates whether the buyer can select the quantity of the line item.
amount	JSON	Optional
amount (anyOf 1)	number	Alternative	The total amount for the line item, calculated as price multiplied by quantity.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
archived	boolean	Optional	Indicates whether the line item is archived.
archivedAt	string	Optional	The date and time when the line item was archived, in ISO 8601 format. Format: date-time
arr	JSON	Optional
arr (anyOf 1)	number	Alternative	The annual recurring revenue for the line item.
arr (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
billingCycleAnchorDate	string	Optional	The anchor date for the billing cycle, in ISO 8601 date format. Format: date
billingPeriodEndDate	string	Optional	The end date of the billing period, in ISO 8601 date format. Format: date
billingPeriodStartDate	string	Optional	The start date of the billing period, in ISO 8601 date format. Format: date
billingStartDelayDays	JSON	Optional
billingStartDelayDays (anyOf 1)	integer	Alternative	The number of days to delay the start of billing. Format: int32
billingStartDelayDays (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
billingStartDelayMonths	JSON	Optional
billingStartDelayMonths (anyOf 1)	integer	Alternative	The number of months to delay the start of billing. Format: int32
billingStartDelayMonths (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
billingStartDelayType	string	Optional	The type of delay for the start of billing. Valid values include 'HS_BILLING_START_DELAY_DAYS', 'HS_BILLING_START_DELAY_MONTHS', and 'HS_RECURRING_BILLING_START_DATE'. Known values: HS_BILLING_START_DELAY_DAYS, HS_BILLING_START_DELAY_MONTHS, HS_RECURRING_BILLING_START_DATE
buyerSelectedQuantityMax	JSON	Optional
buyerSelectedQuantityMax (anyOf 1)	number	Alternative	The maximum quantity the buyer can select for the line item.
buyerSelectedQuantityMax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
buyerSelectedQuantityMin	JSON	Optional
buyerSelectedQuantityMin (anyOf 1)	number	Alternative	The minimum quantity the buyer can select for the line item.
buyerSelectedQuantityMin (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	string	Optional	The date and time when the line item was created, in ISO 8601 format. Format: date-time
description	string	Optional	A text description of the line item.
discount	JSON	Optional
discount (anyOf 1)	number	Alternative	The discount applied to the line item.
discount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
discountPercentage	JSON	Optional
discountPercentage (anyOf 1)	number	Alternative	The percentage discount applied to the line item.
discountPercentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
effectiveUnitPrice	JSON	Optional
effectiveUnitPrice (anyOf 1)	number	Alternative	The effective price per unit after discounts.
effectiveUnitPrice (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
externalId	string	Optional	An external identifier for the line item, used for integration purposes.
id	string	Required within parent	The unique identifier for the line item.
images	string	Optional	A URL or identifier for images associated with the line item.
isEditablePrice	boolean	Optional	Indicates whether the price of the line item is editable.
isOptional	boolean	Optional	Indicates whether the line item is optional.
isParent	boolean	Optional	Indicates whether this line item is a parent line item.
lineItemCurrencyCode	string	Optional	The currency code for the line item, following ISO 4217 format.
mrr	JSON	Optional
mrr (anyOf 1)	number	Alternative	The monthly recurring revenue for the line item.
mrr (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the line item.
parentLineItemId	string	Optional	The unique identifier for the parent line item.
positionOnQuote	JSON	Optional
positionOnQuote (anyOf 1)	integer	Alternative	The position of the line item on a quote, represented as an integer. Format: int32
positionOnQuote (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
postTaxAmount	JSON	Optional
postTaxAmount (anyOf 1)	number	Alternative	The amount after taxes are applied.
postTaxAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preDiscountAmount	JSON	Optional
preDiscountAmount (anyOf 1)	number	Alternative	The amount before any discounts are applied.
preDiscountAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
price	JSON	Optional
price (anyOf 1)	number	Alternative	The price of a single unit of the line item.
price (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
priceBookId	string	Optional	The identifier for the price book associated with the line item.
pricing	Model	Required within parent	Expand Create a payment link — response body — line Items item pricing
pricingModel	string	Optional	The pricing model used for the line item. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'. Known values: FLAT, GRADUATED, STAIRSTEP, VOLUME
productId	string	Optional	The identifier for the product associated with the line item.
productType	string	Optional	The type of product for the line item.
quantity	JSON	Required within parent
quantity (anyOf 1)	number	Alternative	The quantity of the line item, represented as a number.
quantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rampKey	string	Optional	A key used to identify the ramp schedule for the line item.
recurringBillingDayOfMonth	JSON	Optional
recurringBillingDayOfMonth (anyOf 1)	integer	Alternative	The day of the month when recurring billing occurs. Format: int32
recurringBillingDayOfMonth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
recurringBillingEndDate	string	Optional	The end date for recurring billing, in ISO 8601 date format. Format: date
recurringBillingFrequency	string	Optional	The frequency of recurring billing for the line item. Valid values include 'ANNUALLY', 'BIWEEKLY', 'MONTHLY', 'PER_FIVE_YEARS', 'PER_FOUR_YEARS', 'PER_SIX_MONTHS', 'PER_THREE_YEARS', 'PER_TWO_YEARS', 'QUARTERLY', and 'WEEKLY'. Known values: ANNUALLY, BIWEEKLY, MONTHLY, PER_FIVE_YEARS, PER_FOUR_YEARS, PER_SIX_MONTHS, PER_THREE_YEARS, PER_TWO_YEARS, QUARTERLY, WEEKLY
recurringBillingNumberOfPayments	JSON	Optional
recurringBillingNumberOfPayments (anyOf 1)	integer	Alternative	The number of payments for the recurring billing cycle. Format: int32
recurringBillingNumberOfPayments (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
recurringBillingPeriod	string	Optional	The period for recurring billing.
recurringBillingStartDate	string	Optional	The start date for recurring billing, in ISO 8601 date format. Format: date
recurringBillingTerms	string	Optional	The terms of recurring billing. Valid values include 'AUTOMATICALLY_RENEW' and 'FIXED'. Known values: AUTOMATICALLY_RENEW, FIXED
richTextDescription	string	Optional	A rich text formatted description of the line item.
sku	string	Optional	The stock keeping unit (SKU) identifier for the line item.
tax	JSON	Optional
tax (anyOf 1)	number	Alternative	The tax amount applied to the line item.
tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taxAmount	JSON	Optional
taxAmount (anyOf 1)	number	Alternative	The total tax amount for this line item.
taxAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
taxCategory	string	Optional	The tax category applicable to this line item.
taxRateGroupId	string	Optional	The unique identifier for the tax rate group.
tcv	JSON	Optional
tcv (anyOf 1)	number	Alternative	The total contract value for the line item.
tcv (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
termInMonths	JSON	Optional
termInMonths (anyOf 1)	integer	Alternative	The term length for the line item in months. Format: int32
termInMonths (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tierAmount	JSON	Optional
tierAmount (anyOf 1)	number	Alternative	The tiered amount applicable to the line item.
tierAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalDiscount	JSON	Optional
totalDiscount (anyOf 1)	number	Alternative	The total discount amount applied to the line item.
totalDiscount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Optional	The date and time when the line item was last updated, in ISO 8601 format. Format: date-time
variantId	string	Optional	The identifier for the product variant associated with the line item.

Referenced models: Create a payment link — response body — line Items item pricing

Create a payment link — response body — line Items item pricing

Field	Type	Presence	Description and constraints
$	object	Root
prices	array	Required within parent	An array of price entries, each detailing a specific price point within the pricing model.
prices[]	Model	Each item	Expand Create a payment link — response body — line Items item pricing prices item
pricingModel	string	Required within parent	The type of pricing model applied. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'. Known values: FLAT, GRADUATED, STAIRSTEP, VOLUME

Referenced models: Create a payment link — response body — line Items item pricing prices item

Create a payment link — response body — line Items item pricing prices item

Field	Type	Presence	Description and constraints
$	object	Root
currencyCode	string	Required within parent	The currency code for the price, represented as a string.
maxQuantity	JSON	Optional
maxQuantity (anyOf 1)	integer	Alternative	The maximum quantity for which this price is applicable, represented as a string. Format: int32
maxQuantity (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
price	JSON	Required within parent
price (anyOf 1)	number	Alternative	The price of the item, represented as a number.
price (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a payment link — response body — taxes item

Field	Type	Presence	Description and constraints
$	object	Root
archived	boolean	Optional	Indicates whether this tax entry is archived. A boolean value.
archivedAt	string	Optional	The date and time when this tax entry was archived, in ISO 8601 format. Format: date-time
createdAt	string	Optional	The date and time when this tax entry was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this tax entry.
label	string	Optional	A descriptive label for this tax entry.
updatedAt	string	Optional	The date and time when this tax entry was last updated, in ISO 8601 format. Format: date-time
value	JSON	Optional
value (anyOf 1)	number	Alternative	The numerical value of the tax.
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
valueType	string	Optional	The type of value for the tax, which can be either 'FIXED' or 'PERCENT'. Known values: FIXED, PERCENT

Retrieve all payment links — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve all payment links — response body — paging
results	array	Required within parent	An array of PaymentLinkResponse objects, each representing a payment link with its associated details.
results[]	Model	Each item	Expand Create a payment link — response body

Referenced models: Create a payment link — response body, Retrieve all payment links — response body — paging

Retrieve all payment links — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand Retrieve all payment links — response body — paging next

Referenced models: Retrieve all payment links — response body — paging next

Retrieve all payment links — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token that indicates the position after the last item in the current page, used to fetch the next page of results.
link	string	Optional	A string URL that provides a direct link to the next page of results.

Update a payment link — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
acceptedPaymentMethods	array	Optional	An array of strings indicating the accepted payment methods. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.
acceptedPaymentMethods[]	string	Each item	One of: CREDIT_OR_DEBIT_CARD, ACH, SEPA, BACS, PADS, AFFIRM, KLARNA
additionalFormFields	array	Optional	An array of PaymentLinkFormField objects representing additional form fields for the payment link.
additionalFormFields[]	Model	Each item	Expand Create a payment link — request body — body additional Form Fields item
automatedSalesTaxEnabled	boolean	Optional	A boolean indicating whether automated sales tax is enabled.
businessUnitId	object	Required within parent	An object representing the business unit ID associated with the payment link.
collectFullBillingAddress	boolean	Optional	A boolean indicating whether to collect the full billing address during checkout.
collectShippingAddress	boolean	Optional	A boolean indicating whether to collect the shipping address during checkout.
createContractOnPurchase	boolean	Optional	A boolean indicating whether a contract should be created upon purchase.
currencyCode	string	Optional	The currency code for the payment link, represented as a string.
dealConfigurations	object	Required within parent	An object containing deal configuration settings.
descriptionHtml	object	Required within parent	An object containing the HTML description of the payment link.
discount	Model	Optional	Expand Create a payment link — request body — body discount
discountCodeEnabled	boolean	Optional	A boolean indicating whether discount codes are enabled for the payment link.
discountObjectId	object	Required within parent	An object representing the discount object ID associated with the payment link.
domainId	object	Required within parent	An object representing the domain ID associated with the payment link.
enableDefaultCheckoutFees	boolean	Optional	A boolean indicating whether default checkout fees are enabled.
expirationSettings	object	Required within parent	An object representing the expiration settings for the payment link.
feeObjectIds	array	Optional	An array of strings representing the IDs of fee objects associated with the payment link.
feeObjectIds[]	string	Each item
fees	array	Optional	An array of FeeRequest objects representing the fees associated with the payment link.
fees[]	Model	Each item	Expand Create a payment link — request body — body fees item
includeEmailInSuccessRedirect	boolean	Optional	A boolean indicating whether to include the email in the success redirect.
isOneTimeUseEnabled	boolean	Optional	A boolean indicating whether the payment link is enabled for one-time use.
lineItemObjectIds	array	Optional	An array of strings representing the IDs of line item objects associated with the payment link.
lineItemObjectIds[]	string	Each item
lineItems	array	Optional	An array of line item objects, which can be of types LineItemCustomCreateRequest, LineItemFromProductCreateRequest, or LineItemCloneCreateRequest.
lineItems[]	JSON	Each item
lineItems[] (oneOf 1)	Model	Alternative	Expand Create a payment link — request body — body / lineItems / item / mode: CUSTOM
lineItems[] (oneOf 2)	Model	Alternative	Expand Create a payment link — request body — body / lineItems / item / mode: FROM PRODUCT
lineItems[] (oneOf 3)	Model	Alternative	Expand Create a payment link — request body — body / lineItems / item / mode: CLONE
paymentLinkName	string	Optional	The name of the payment link, represented as a string.
state	string	Optional	The state of the payment link, represented as a string. Valid values are 'ON' and 'OFF'. One of: OFF, ON
storePaymentMethodAtCheckout	boolean	Optional	A boolean indicating whether the payment method should be stored at checkout.
successUrl	object	Required within parent	An object representing the success URL where the user is redirected after a successful transaction.
taxObjectIds	array	Optional	An array of strings representing the IDs of tax objects associated with the payment link.
taxObjectIds[]	string	Each item
taxes	array	Optional	An array of TaxRequest objects representing the taxes associated with the payment link.
taxes[]	Model	Each item	Expand Create a payment link — request body — body taxes item

Referenced models: Create a payment link — request body — body discount, Create a payment link — request body — body fees item, Create a payment link — request body — body / lineItems / item / mode: CLONE, Create a payment link — request body — body / lineItems / item / mode: CUSTOM, Create a payment link — request body — body / lineItems / item / mode: FROM PRODUCT, Create a payment link — request body — body additional Form Fields item, Create a payment link — request body — body taxes item