{ "openapi" : "3.0.1", "info" : { "title" : "Commerce Payment Links", "description" : "Basepom for all HubSpot Projects", "version" : "2026-09-beta", "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }, "servers" : [ { "url" : "https://api.hubapi.com" } ], "tags" : [ { "name" : "Basic" } ], "paths" : { "/commerce/payment-links/2026-09-beta/payment-links" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve all payment links", "description" : "Retrieve a list of payment links from your HubSpot account. This endpoint allows you to filter and sort payment links based on various criteria such as creation and update timestamps. It supports pagination and can include archived payment links if specified.", "operationId" : "get-/commerce/payment-links/2026-09-beta/payment-links", "parameters" : [ { "name" : "after", "in" : "query", "description" : "The paging cursor token of the last successfully read resource, returned as the `paging.next.after` JSON property of a paged response containing more results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "archived", "in" : "query", "description" : "Whether to return only results that have been archived. Defaults to false.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } }, { "name" : "createdAfter", "in" : "query", "description" : "Filter results to include only those created after the specified timestamp.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int64", "example" : null } }, { "name" : "createdAt", "in" : "query", "description" : "Filter results by the exact creation timestamp.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int64", "example" : null } }, { "name" : "createdBefore", "in" : "query", "description" : "Filter results to include only those created before the specified timestamp.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int64", "example" : null } }, { "name" : "limit", "in" : "query", "description" : "The maximum number of results to display per page. Defaults to 20.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int32", "example" : null, "default" : 20 } }, { "name" : "sort", "in" : "query", "description" : "The field by which to sort the results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "example" : null } }, { "name" : "updatedAfter", "in" : "query", "description" : "Filter results to include only those updated after the specified timestamp.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int64", "example" : null } }, { "name" : "updatedAt", "in" : "query", "description" : "Filter results by the exact update timestamp.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int64", "example" : null } }, { "name" : "updatedBefore", "in" : "query", "description" : "Filter results to include only those updated before the specified timestamp.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "integer", "format" : "int64", "example" : null } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CollectionResponsePaymentLinkResponseForwardPaging" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "payment-links-read" ] } ] }, "post" : { "tags" : [ "Basic" ], "summary" : "Create a payment link", "description" : "Create a new payment link in your HubSpot account. This endpoint allows you to specify various attributes for the payment link, such as accepted payment methods, currency, and additional form fields. The payment link can be configured for one-time use and can also collect shipping and billing addresses. This operation requires a valid JSON request body. Some defaults will be applied if no value provided.", "operationId" : "post-/commerce/payment-links/2026-09-beta/payment-links", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkCreateRequest" }, "example" : null } }, "required" : true }, "responses" : { "201" : { "description" : "successful operation", "headers" : { "Location" : { "description" : "URL of the newly created resource", "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "payment-links-write" ] } ] } }, "/commerce/payment-links/2026-09-beta/payment-links/{paymentLinkId}" : { "get" : { "tags" : [ "Basic" ], "summary" : "Retrieve payment link", "description" : "Retrieve details of a specific payment link using its unique identifier. This endpoint allows you to access information about the payment link, including its status and configuration. It is useful for checking the current settings or status of a payment link in your HubSpot account.", "operationId" : "get-/commerce/payment-links/2026-09-beta/payment-links/{paymentLinkId}", "parameters" : [ { "name" : "paymentLinkId", "in" : "path", "description" : "The unique identifier of the payment link to retrieve.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } }, { "name" : "archived", "in" : "query", "description" : "Whether to return only results that have been archived. Defaults to false.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean", "example" : null, "default" : false } } ], "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "payment-links-read" ] } ] }, "delete" : { "tags" : [ "Basic" ], "summary" : "Delete a payment link", "description" : "Delete a specific payment link in your HubSpot account. This operation is irreversible and will remove the payment link identified by the provided ID. Use this endpoint to manage and clean up payment links that are no longer needed.", "operationId" : "delete-/commerce/payment-links/2026-09-beta/payment-links/{paymentLinkId}", "parameters" : [ { "name" : "paymentLinkId", "in" : "path", "description" : "The unique identifier of the payment link to delete.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "responses" : { "204" : { "description" : "No content", "content" : { } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "payment-links-delete" ] } ] }, "patch" : { "tags" : [ "Basic" ], "summary" : "Update a payment link", "description" : "Update a payment link by ID.", "operationId" : "patch-/commerce/payment-links/2026-09-beta/payment-links/{paymentLinkId}_/commerce/payment-links/2026-09-beta/payment-links/{paymentLinkId}", "parameters" : [ { "name" : "paymentLinkId", "in" : "path", "description" : "The ID of the payment link to update.", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "example" : null } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkUpdateRequest" }, "example" : null } }, "required" : true }, "responses" : { "200" : { "description" : "successful operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PaymentLinkResponse" }, "example" : null } } }, "default" : { "description" : "", "$ref" : "#/components/responses/Error" } }, "security" : [ { "oauth2" : [ "payment-links-write" ] } ] } } }, "components" : { "schemas" : { "CollectionResponsePaymentLinkResponseForwardPaging" : { "required" : [ "results" ], "type" : "object", "properties" : { "paging" : { "$ref" : "#/components/schemas/ForwardPaging" }, "results" : { "type" : "array", "description" : "An array of PaymentLinkResponse objects, each representing a payment link with its associated details.", "example" : null, "items" : { "$ref" : "#/components/schemas/PaymentLinkResponse" } } }, "example" : null }, "DealConfigurations" : { "required" : [ "createNewDealOnPurchase" ], "type" : "object", "properties" : { "createNewDealOnPurchase" : { "type" : "boolean", "description" : "A boolean indicating whether a new deal should be created in HubSpot upon a purchase. Required field.", "example" : null }, "pipelineStageId" : { "type" : "string", "description" : "The identifier for the pipeline stage where the new deal will be placed. This is a string value.", "example" : null } }, "example" : null }, "DiscountRequest" : { "required" : [ "label", "value", "valueType" ], "type" : "object", "properties" : { "label" : { "type" : "string", "description" : "A descriptive label for the discount. This is a string.", "example" : null }, "value" : { "type" : "number", "description" : "The numerical value of the discount to be applied. This is a number.", "example" : null }, "valueType" : { "type" : "string", "description" : "The type of discount value, which can either be 'FIXED' or 'PERCENT'.", "example" : null, "enum" : [ "FIXED", "PERCENT" ] } }, "example" : null }, "DiscountResponse" : { "required" : [ "id" ], "type" : "object", "properties" : { "archived" : { "type" : "boolean", "description" : "Indicates whether this discount has been archived. A boolean value.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The date and time when this discount was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when this discount was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for this discount.", "example" : null }, "label" : { "type" : "string", "description" : "A descriptive label for the discount.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when this discount was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "value" : { "type" : "number", "description" : "The numerical value of the discount.", "example" : null }, "valueType" : { "type" : "string", "description" : "The type of discount value, which can be either 'FIXED' or 'PERCENT'.", "example" : null, "enum" : [ "FIXED", "PERCENT" ] } }, "example" : null }, "Error" : { "required" : [ "category", "correlationId", "message" ], "type" : "object", "properties" : { "category" : { "type" : "string", "description" : "The error category.", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition, represented as an object with additional properties.", "example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}" }, "correlationId" : { "type" : "string", "description" : "A unique identifier for the request. Include this value with any error reports or support tickets.", "format" : "uuid", "example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf" }, "errors" : { "type" : "array", "description" : "Further information about the error, represented as an array of ErrorDetail objects.", "example" : null, "items" : { "$ref" : "#/components/schemas/ErrorDetail" } }, "links" : { "type" : "object", "additionalProperties" : { "type" : "string", "example" : null }, "description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate.", "example" : "An error occurred" }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error.", "example" : null } }, "example" : { "message" : "Invalid input (details will vary based on the error)", "correlationId" : "aeb5f871-7f07-4993-9211-075dc63e7cbf", "category" : "VALIDATION_ERROR", "links" : { "knowledge-base" : "https://www.hubspot.com/products/service/knowledge-base" } } }, "ErrorDetail" : { "required" : [ "message" ], "type" : "object", "properties" : { "code" : { "type" : "string", "description" : "The status code associated with the error detail.", "example" : null }, "context" : { "type" : "object", "additionalProperties" : { "type" : "array", "example" : null, "items" : { "type" : "string", "example" : null } }, "description" : "Context about the error condition, represented as an object with additional properties that provide more details.", "example" : "{missingScopes=[scope1, scope2]}" }, "in" : { "type" : "string", "description" : "The name of the field or parameter in which the error was found.", "example" : null }, "message" : { "type" : "string", "description" : "A human readable message describing the error along with remediation steps where appropriate.", "example" : null }, "subCategory" : { "type" : "string", "description" : "A specific category that contains more specific detail about the error.", "example" : null } }, "example" : null }, "FeeRequest" : { "required" : [ "label", "value", "valueType" ], "type" : "object", "properties" : { "label" : { "type" : "string", "description" : "A descriptive label for the fee, represented as a string.", "example" : null }, "value" : { "type" : "number", "description" : "The numerical value of the fee. This is a number representing either a fixed amount or a percentage, depending on the valueType.", "example" : null }, "valueType" : { "type" : "string", "description" : "The type of the fee value, indicating whether it is a fixed amount or a percentage. Valid values include 'FIXED' and 'PERCENT'.", "example" : null, "enum" : [ "FIXED", "PERCENT" ] } }, "example" : null }, "FeeResponse" : { "required" : [ "id" ], "type" : "object", "properties" : { "archived" : { "type" : "boolean", "description" : "Indicates whether this fee has been archived. A boolean value.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The date and time when this fee was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when this fee was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for this fee.", "example" : null }, "label" : { "type" : "string", "description" : "A descriptive label for the fee.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when this fee was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "value" : { "type" : "number", "description" : "The monetary value of the fee. A number representing the fee amount.", "example" : null }, "valueType" : { "type" : "string", "description" : "The type of value for the fee, which can be either 'FIXED' or 'PERCENT'.", "example" : null, "enum" : [ "FIXED", "PERCENT" ] } }, "example" : null }, "FormFieldOption" : { "required" : [ "label", "value" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A string providing additional information or context about the form field option.", "example" : null }, "label" : { "type" : "string", "description" : "A string representing the display name of the form field option.", "example" : null }, "value" : { "type" : "string", "description" : "A string representing the underlying value associated with the form field option.", "example" : null } }, "example" : null }, "ForwardPaging" : { "type" : "object", "properties" : { "next" : { "$ref" : "#/components/schemas/NextPage" } }, "example" : null }, "LineItem" : { "required" : [ "id", "name", "pricing", "quantity" ], "type" : "object", "properties" : { "acv" : { "type" : "number", "description" : "The annual contract value for the line item.", "example" : null }, "allowBuyerSelectedQuantity" : { "type" : "boolean", "description" : "Indicates whether the buyer can select the quantity of the line item.", "example" : null }, "amount" : { "type" : "number", "description" : "The total amount for the line item, calculated as price multiplied by quantity.", "example" : null }, "archived" : { "type" : "boolean", "description" : "Indicates whether the line item is archived.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The date and time when the line item was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "arr" : { "type" : "number", "description" : "The annual recurring revenue for the line item.", "example" : null }, "billingCycleAnchorDate" : { "type" : "string", "description" : "The anchor date for the billing cycle, in ISO 8601 date format.", "format" : "date", "example" : null }, "billingPeriodEndDate" : { "type" : "string", "description" : "The end date of the billing period, in ISO 8601 date format.", "format" : "date", "example" : null }, "billingPeriodStartDate" : { "type" : "string", "description" : "The start date of the billing period, in ISO 8601 date format.", "format" : "date", "example" : null }, "billingStartDelayDays" : { "type" : "integer", "description" : "The number of days to delay the start of billing.", "format" : "int32", "example" : null }, "billingStartDelayMonths" : { "type" : "integer", "description" : "The number of months to delay the start of billing.", "format" : "int32", "example" : null }, "billingStartDelayType" : { "type" : "string", "description" : "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'.", "example" : null, "enum" : [ "HS_BILLING_START_DELAY_DAYS", "HS_BILLING_START_DELAY_MONTHS", "HS_RECURRING_BILLING_START_DATE" ] }, "buyerSelectedQuantityMax" : { "type" : "number", "description" : "The maximum quantity the buyer can select for the line item.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "number", "description" : "The minimum quantity the buyer can select for the line item.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when the line item was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "description" : { "type" : "string", "description" : "A text description of the line item.", "example" : null }, "discount" : { "type" : "number", "description" : "The discount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "number", "description" : "The percentage discount applied to the line item.", "example" : null }, "effectiveUnitPrice" : { "type" : "number", "description" : "The effective price per unit after discounts.", "example" : null }, "externalId" : { "type" : "string", "description" : "An external identifier for the line item, used for integration purposes.", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the line item.", "example" : null }, "images" : { "type" : "string", "description" : "A URL or identifier for images associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "boolean", "description" : "Indicates whether the price of the line item is editable.", "example" : null }, "isOptional" : { "type" : "boolean", "description" : "Indicates whether the line item is optional.", "example" : null }, "lineItemCurrencyCode" : { "type" : "string", "description" : "The currency code for the line item, following ISO 4217 format.", "example" : null }, "mrr" : { "type" : "number", "description" : "The monthly recurring revenue for the line item.", "example" : null }, "name" : { "type" : "string", "description" : "The name of the line item.", "example" : null }, "positionOnQuote" : { "type" : "integer", "description" : "The position of the line item on a quote, represented as an integer.", "format" : "int32", "example" : null }, "postTaxAmount" : { "type" : "number", "description" : "The amount after taxes are applied.", "example" : null }, "preDiscountAmount" : { "type" : "number", "description" : "The amount before any discounts are applied.", "example" : null }, "price" : { "type" : "number", "description" : "The price of a single unit of the line item.", "example" : null }, "priceBookId" : { "type" : "string", "description" : "The identifier for the price book associated with the line item.", "example" : null }, "pricing" : { "$ref" : "#/components/schemas/Pricing" }, "pricingModel" : { "type" : "string", "description" : "The pricing model used for the line item. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.", "example" : null, "enum" : [ "FLAT", "GRADUATED", "STAIRSTEP", "VOLUME" ] }, "productId" : { "type" : "string", "description" : "The identifier for the product associated with the line item.", "example" : null }, "productType" : { "type" : "string", "description" : "The type of product for the line item.", "example" : null }, "quantity" : { "type" : "number", "description" : "The quantity of the line item, represented as a number.", "example" : null }, "rampKey" : { "type" : "string", "description" : "A key used to identify the ramp schedule for the line item.", "example" : null }, "recurringBillingDayOfMonth" : { "type" : "integer", "description" : "The day of the month when recurring billing occurs.", "format" : "int32", "example" : null }, "recurringBillingEndDate" : { "type" : "string", "description" : "The end date for recurring billing, in ISO 8601 date format.", "format" : "date", "example" : null }, "recurringBillingFrequency" : { "type" : "string", "description" : "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'.", "example" : null, "enum" : [ "ANNUALLY", "BIWEEKLY", "MONTHLY", "PER_FIVE_YEARS", "PER_FOUR_YEARS", "PER_SIX_MONTHS", "PER_THREE_YEARS", "PER_TWO_YEARS", "QUARTERLY", "WEEKLY" ] }, "recurringBillingNumberOfPayments" : { "type" : "integer", "description" : "The number of payments for the recurring billing cycle.", "format" : "int32", "example" : null }, "recurringBillingPeriod" : { "type" : "string", "description" : "The period for recurring billing.", "example" : null }, "recurringBillingStartDate" : { "type" : "string", "description" : "The start date for recurring billing, in ISO 8601 date format.", "format" : "date", "example" : null }, "recurringBillingTerms" : { "type" : "string", "description" : "The terms of recurring billing. Valid values include 'AUTOMATICALLY_RENEW' and 'FIXED'.", "example" : null, "enum" : [ "AUTOMATICALLY_RENEW", "FIXED" ] }, "richTextDescription" : { "type" : "string", "description" : "A rich text formatted description of the line item.", "example" : null }, "sku" : { "type" : "string", "description" : "The stock keeping unit (SKU) identifier for the line item.", "example" : null }, "tax" : { "type" : "number", "description" : "The tax amount applied to the line item.", "example" : null }, "tcv" : { "type" : "number", "description" : "The total contract value for the line item.", "example" : null }, "termInMonths" : { "type" : "integer", "description" : "The term length for the line item in months.", "format" : "int32", "example" : null }, "tierAmount" : { "type" : "number", "description" : "The tiered amount applicable to the line item.", "example" : null }, "totalDiscount" : { "type" : "number", "description" : "The total discount amount applied to the line item.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when the line item was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "variantId" : { "type" : "string", "description" : "The identifier for the product variant associated with the line item.", "example" : null } }, "example" : null }, "LineItemCloneCreateRequest" : { "title" : "CLONE", "required" : [ "allowBuyerSelectedQuantity", "billingCycleAnchorDate", "billingStartDelayDays", "billingStartDelayMonths", "billingStartDelayType", "buyerSelectedQuantityMax", "buyerSelectedQuantityMin", "description", "discount", "discountPercentage", "externalId", "images", "isEditablePrice", "isOptional", "lineItemCurrencyCode", "mode", "name", "positionOnQuote", "priceBookId", "pricing", "productType", "quantity", "recurringBillingEndDate", "recurringBillingFrequency", "recurringBillingNumberOfPayments", "recurringBillingPeriod", "recurringBillingStartDate", "recurringBillingTerms", "richTextDescription", "sku", "sourceLineItemId", "variantId" ], "type" : "object", "properties" : { "allowBuyerSelectedQuantity" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the buyer can select the quantity of the line item.", "example" : null }, "billingCycleAnchorDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the anchor date for the billing cycle of the line item.", "example" : null }, "billingStartDelayDays" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of days to delay the start of billing for the line item.", "example" : null }, "billingStartDelayMonths" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of months to delay the start of billing for the line item.", "example" : null }, "billingStartDelayType" : { "type" : "object", "properties" : { }, "description" : "An object representing the type of delay for the start of billing for the line item.", "example" : null }, "buyerSelectedQuantityMax" : { "type" : "object", "properties" : { }, "description" : "An object representing the maximum quantity the buyer can select for the line item.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "object", "properties" : { }, "description" : "An object representing the minimum quantity the buyer can select for the line item.", "example" : null }, "description" : { "type" : "object", "properties" : { }, "description" : "An object representing the description of the line item.", "example" : null }, "discount" : { "type" : "object", "properties" : { }, "description" : "An object representing the discount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "object", "properties" : { }, "description" : "An object representing the discount percentage applied to the line item.", "example" : null }, "externalId" : { "type" : "object", "properties" : { }, "description" : "An object representing an external identifier for the line item.", "example" : null }, "images" : { "type" : "object", "properties" : { }, "description" : "An object representing the images associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the price of the line item is editable.", "example" : null }, "isOptional" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the line item is optional.", "example" : null }, "lineItemCurrencyCode" : { "type" : "object", "properties" : { }, "description" : "An object representing the currency code for the line item.", "example" : null }, "mode" : { "type" : "string", "description" : "A string indicating the mode of the line item creation, which is 'CLONE' for this component.", "example" : null, "default" : "CLONE", "enum" : [ "CLONE" ] }, "name" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the line item.", "example" : null }, "positionOnQuote" : { "type" : "object", "properties" : { }, "description" : "An object representing the position of the line item on the quote.", "example" : null }, "priceBookId" : { "type" : "object", "properties" : { }, "description" : "An object representing the price book ID associated with the line item.", "example" : null }, "pricing" : { "type" : "object", "properties" : { }, "description" : "An object representing the pricing details of the line item.", "example" : null }, "productType" : { "type" : "object", "properties" : { }, "description" : "An object representing the type of product for the line item.", "example" : null }, "quantity" : { "type" : "object", "properties" : { }, "description" : "An object representing the quantity of the line item.", "example" : null }, "recurringBillingEndDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the end date for recurring billing of the line item.", "example" : null }, "recurringBillingFrequency" : { "type" : "object", "properties" : { }, "description" : "An object representing the frequency of recurring billing for the line item.", "example" : null }, "recurringBillingNumberOfPayments" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of payments for recurring billing of the line item.", "example" : null }, "recurringBillingPeriod" : { "type" : "object", "properties" : { }, "description" : "An object representing the billing period for recurring billing of the line item.", "example" : null }, "recurringBillingStartDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the start date for recurring billing of the line item.", "example" : null }, "recurringBillingTerms" : { "type" : "object", "properties" : { }, "description" : "An object representing the terms of recurring billing for the line item.", "example" : null }, "richTextDescription" : { "type" : "object", "properties" : { }, "description" : "An object representing the rich text description of the line item.", "example" : null }, "sku" : { "type" : "object", "properties" : { }, "description" : "An object representing the stock keeping unit (SKU) of the line item.", "example" : null }, "sourceLineItemId" : { "type" : "string", "description" : "A string representing the ID of the source line item being cloned.", "example" : null }, "variantId" : { "type" : "object", "properties" : { }, "description" : "An object representing the variant ID of the line item.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "LineItemCustomCreateRequest" : { "title" : "CUSTOM", "required" : [ "mode", "name", "pricing", "quantity" ], "type" : "object", "properties" : { "allowBuyerSelectedQuantity" : { "type" : "boolean", "description" : "A boolean specifying if the buyer can select the quantity of the line item.", "example" : null }, "billingCycleAnchorDate" : { "type" : "string", "description" : "A string in date format representing the anchor date for the billing cycle.", "format" : "date", "example" : null }, "billingStartDelayDays" : { "type" : "integer", "description" : "An integer indicating the number of days to delay the start of billing.", "format" : "int32", "example" : null }, "billingStartDelayMonths" : { "type" : "integer", "description" : "An integer indicating the number of months to delay the start of billing.", "format" : "int32", "example" : null }, "billingStartDelayType" : { "type" : "string", "description" : "A string specifying the type of billing start delay. Valid values include 'HS_BILLING_START_DELAY_DAYS', 'HS_BILLING_START_DELAY_MONTHS', and 'HS_RECURRING_BILLING_START_DATE'.", "example" : null, "enum" : [ "HS_BILLING_START_DELAY_DAYS", "HS_BILLING_START_DELAY_MONTHS", "HS_RECURRING_BILLING_START_DATE" ] }, "buyerSelectedQuantityMax" : { "type" : "number", "description" : "A number indicating the maximum quantity the buyer can select.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "number", "description" : "A number indicating the minimum quantity the buyer can select.", "example" : null }, "description" : { "type" : "string", "description" : "A string providing a description of the line item.", "example" : null }, "discount" : { "type" : "number", "description" : "A number representing the discount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "number", "description" : "A number indicating the discount percentage applied to the line item.", "example" : null }, "externalId" : { "type" : "string", "description" : "A string representing an external identifier for the line item.", "example" : null }, "images" : { "type" : "string", "description" : "A string containing URLs or identifiers for images associated with the line item.", "example" : null }, "isEditablePrice" : { "type" : "boolean", "description" : "A boolean indicating whether the price of the line item is editable.", "example" : null }, "isOptional" : { "type" : "boolean", "description" : "A boolean indicating whether the line item is optional.", "example" : null }, "lineItemCurrencyCode" : { "type" : "string", "description" : "A string representing the currency code for the line item.", "example" : null }, "mode" : { "type" : "string", "description" : "A string that indicates the mode of the line item, which is set to 'CUSTOM'.", "example" : null, "default" : "CUSTOM", "enum" : [ "CUSTOM" ] }, "name" : { "type" : "string", "description" : "A string representing the name of the line item.", "example" : null }, "positionOnQuote" : { "type" : "integer", "description" : "An integer indicating the position of the line item on a quote.", "format" : "int32", "example" : null }, "priceBookId" : { "type" : "string", "description" : "A string that identifies the price book associated with the line item.", "example" : null }, "pricing" : { "$ref" : "#/components/schemas/PricingFullUpdateRequest" }, "productId" : { "type" : "string", "description" : "A string that identifies the product associated with the line item.", "example" : null }, "productType" : { "type" : "string", "description" : "A string indicating the type of product for the line item.", "example" : null }, "quantity" : { "type" : "number", "description" : "A number indicating the quantity of the line item.", "example" : null }, "recurringBillingEndDate" : { "type" : "string", "description" : "A string in date format indicating the end date of recurring billing.", "format" : "date", "example" : null }, "recurringBillingFrequency" : { "type" : "string", "description" : "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'.", "example" : null, "enum" : [ "ANNUALLY", "BIWEEKLY", "MONTHLY", "PER_FIVE_YEARS", "PER_FOUR_YEARS", "PER_SIX_MONTHS", "PER_THREE_YEARS", "PER_TWO_YEARS", "QUARTERLY", "WEEKLY" ] }, "recurringBillingNumberOfPayments" : { "type" : "integer", "description" : "An integer representing the number of payments for recurring billing.", "format" : "int32", "example" : null }, "recurringBillingPeriod" : { "type" : "string", "description" : "A string representing the period of recurring billing.", "example" : null }, "recurringBillingStartDate" : { "type" : "string", "description" : "A string in date format indicating the start date of recurring billing.", "format" : "date", "example" : null }, "recurringBillingTerms" : { "type" : "string", "description" : "A string specifying the terms of recurring billing. Valid values include 'AUTOMATICALLY_RENEW' and 'FIXED'.", "example" : null, "enum" : [ "AUTOMATICALLY_RENEW", "FIXED" ] }, "richTextDescription" : { "type" : "string", "description" : "A string containing a rich text description of the line item.", "example" : null }, "sku" : { "type" : "string", "description" : "A string representing the stock keeping unit (SKU) of the line item.", "example" : null }, "variantId" : { "type" : "string", "description" : "A string representing the variant identifier of the product.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "LineItemFromProductCreateRequest" : { "title" : "FROM_PRODUCT", "required" : [ "allowBuyerSelectedQuantity", "billingCycleAnchorDate", "billingStartDelayDays", "billingStartDelayMonths", "billingStartDelayType", "buyerSelectedQuantityMax", "buyerSelectedQuantityMin", "description", "discount", "discountPercentage", "externalId", "images", "isEditablePrice", "isOptional", "lineItemCurrencyCode", "mode", "name", "positionOnQuote", "priceBookId", "pricing", "productId", "productType", "quantity", "recurringBillingEndDate", "recurringBillingFrequency", "recurringBillingNumberOfPayments", "recurringBillingPeriod", "recurringBillingStartDate", "recurringBillingTerms", "richTextDescription", "sku", "variantId" ], "type" : "object", "properties" : { "allowBuyerSelectedQuantity" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the buyer can select the quantity of the product.", "example" : null }, "billingCycleAnchorDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the anchor date for the billing cycle.", "example" : null }, "billingStartDelayDays" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of days to delay the start of billing.", "example" : null }, "billingStartDelayMonths" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of months to delay the start of billing.", "example" : null }, "billingStartDelayType" : { "type" : "object", "properties" : { }, "description" : "An object representing the type of delay for the start of billing.", "example" : null }, "buyerSelectedQuantityMax" : { "type" : "object", "properties" : { }, "description" : "An object representing the maximum quantity the buyer can select.", "example" : null }, "buyerSelectedQuantityMin" : { "type" : "object", "properties" : { }, "description" : "An object representing the minimum quantity the buyer can select.", "example" : null }, "description" : { "type" : "object", "properties" : { }, "description" : "An object representing the description of the product associated with the line item.", "example" : null }, "discount" : { "type" : "object", "properties" : { }, "description" : "An object representing any discount applied to the line item.", "example" : null }, "discountPercentage" : { "type" : "object", "properties" : { }, "description" : "An object representing the percentage discount applied to the line item.", "example" : null }, "externalId" : { "type" : "object", "properties" : { }, "description" : "An object representing an external identifier for the line item.", "example" : null }, "images" : { "type" : "object", "properties" : { }, "description" : "An object representing images associated with the product.", "example" : null }, "isEditablePrice" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the price of the line item is editable.", "example" : null }, "isOptional" : { "type" : "object", "properties" : { }, "description" : "An object indicating whether the line item is optional.", "example" : null }, "lineItemCurrencyCode" : { "type" : "object", "properties" : { }, "description" : "An object representing the currency code for the line item.", "example" : null }, "mode" : { "type" : "string", "description" : "A string indicating the mode of the line item creation. The default and only valid value is 'FROM_PRODUCT'.", "example" : null, "default" : "FROM_PRODUCT", "enum" : [ "FROM_PRODUCT" ] }, "name" : { "type" : "object", "properties" : { }, "description" : "An object representing the name of the product associated with the line item.", "example" : null }, "positionOnQuote" : { "type" : "object", "properties" : { }, "description" : "An object representing the position of the line item on a quote.", "example" : null }, "priceBookId" : { "type" : "object", "properties" : { }, "description" : "An object representing the ID of the price book associated with the product.", "example" : null }, "pricing" : { "type" : "object", "properties" : { }, "description" : "An object representing the pricing details of the line item.", "example" : null }, "productId" : { "type" : "string", "description" : "A string representing the unique identifier of the product.", "example" : null }, "productType" : { "type" : "object", "properties" : { }, "description" : "An object representing the type of product.", "example" : null }, "quantity" : { "type" : "object", "properties" : { }, "description" : "An object representing the quantity of the product to be included in the line item.", "example" : null }, "recurringBillingEndDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the end date of the recurring billing cycle.", "example" : null }, "recurringBillingFrequency" : { "type" : "object", "properties" : { }, "description" : "An object representing the frequency of recurring billing for the line item.", "example" : null }, "recurringBillingNumberOfPayments" : { "type" : "object", "properties" : { }, "description" : "An object representing the number of payments in the recurring billing cycle.", "example" : null }, "recurringBillingPeriod" : { "type" : "object", "properties" : { }, "description" : "An object representing the period of the recurring billing cycle.", "example" : null }, "recurringBillingStartDate" : { "type" : "object", "properties" : { }, "description" : "An object representing the start date of the recurring billing cycle.", "example" : null }, "recurringBillingTerms" : { "type" : "object", "properties" : { }, "description" : "An object representing the terms of the recurring billing cycle.", "example" : null }, "richTextDescription" : { "type" : "object", "properties" : { }, "description" : "An object representing a rich text description of the product associated with the line item.", "example" : null }, "sku" : { "type" : "object", "properties" : { }, "description" : "An object representing the stock keeping unit (SKU) of the product.", "example" : null }, "variantId" : { "type" : "object", "properties" : { }, "description" : "An object representing the variant ID of the product.", "example" : null } }, "example" : null, "x-hubspot-sub-type-impl" : true }, "NextPage" : { "required" : [ "after" ], "type" : "object", "properties" : { "after" : { "type" : "string", "description" : "A string token that indicates the position after the last item in the current page, used to fetch the next page of results.", "example" : null }, "link" : { "type" : "string", "description" : "A string URL that provides a direct link to the next page of results.", "example" : null } }, "description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response", "example" : null }, "PaymentLinkCreateRequest" : { "required" : [ "acceptedPaymentMethods", "additionalFormFields", "currencyCode", "discountObjectIds", "enableDefaultCheckoutFees", "feeObjectIds", "fees", "includeEmailInSuccessRedirect", "isOneTimeUseEnabled", "lineItemObjectIds", "lineItems", "paymentLinkName", "state", "taxObjectIds", "taxes" ], "type" : "object", "properties" : { "acceptedPaymentMethods" : { "type" : "array", "description" : "An array of accepted payment methods for the payment link. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS" ] } }, "additionalFormFields" : { "type" : "array", "description" : "An array of PaymentLinkFormField objects representing additional form fields to be included in the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/PaymentLinkFormField" } }, "automatedSalesTaxEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether automated sales tax is enabled.", "example" : null }, "businessUnitId" : { "type" : "string", "description" : "A string representing the business unit ID associated with the payment link.", "example" : null }, "collectFullBillingAddress" : { "type" : "boolean", "description" : "A boolean indicating whether to collect the full billing address during checkout.", "example" : null }, "collectShippingAddress" : { "type" : "boolean", "description" : "A boolean indicating whether the shipping address should be collected during checkout.", "example" : null }, "currencyCode" : { "type" : "string", "description" : "The currency code for the payment, represented as a string.", "example" : null }, "dealConfigurations" : { "$ref" : "#/components/schemas/DealConfigurations" }, "descriptionHtml" : { "type" : "string", "description" : "A string containing the HTML description of the payment link.", "example" : null }, "discount" : { "$ref" : "#/components/schemas/DiscountRequest" }, "discountCodeEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether discount codes are enabled for the payment link.", "example" : null }, "discountObjectId" : { "type" : "string", "description" : "A string representing the object ID of a discount associated with the payment link.", "example" : null }, "discountObjectIds" : { "type" : "array", "description" : "An array of strings representing the IDs of discount objects associated with the payment link.", "example" : null, "items" : { "type" : "string", "example" : null } }, "domainId" : { "type" : "string", "description" : "The domain ID associated with the payment link, represented as a string.", "example" : null }, "enableDefaultCheckoutFees" : { "type" : "boolean", "description" : "A boolean indicating whether default checkout fees are enabled.", "example" : null }, "feeObjectIds" : { "type" : "array", "description" : "An array of strings representing the IDs of fee objects associated with the payment link.", "example" : null, "items" : { "type" : "string", "example" : null } }, "fees" : { "type" : "array", "description" : "An array of FeeRequest objects, representing the fees to be applied to the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/FeeRequest" } }, "includeEmailInSuccessRedirect" : { "type" : "boolean", "description" : "A boolean indicating whether to include the email in the success redirect URL.", "example" : null }, "isOneTimeUseEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether the payment link is enabled for one-time use.", "example" : null }, "lineItemObjectIds" : { "type" : "array", "description" : "An array of line item object IDs associated with the payment link, each represented as a string.", "example" : null, "items" : { "type" : "string", "example" : null } }, "lineItems" : { "type" : "array", "description" : "An array of line items, which can be custom, from a product, or cloned, as defined by their respective schemas.", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/LineItemCustomCreateRequest" }, { "$ref" : "#/components/schemas/LineItemFromProductCreateRequest" }, { "$ref" : "#/components/schemas/LineItemCloneCreateRequest" } ] } }, "paymentLinkName" : { "type" : "string", "description" : "The name of the payment link. It is a string value.", "example" : null }, "state" : { "type" : "string", "description" : "The state of the payment link, represented as a string. Valid values are 'ON' and 'OFF'.", "example" : null, "enum" : [ "OFF", "ON" ] }, "storePaymentMethodAtCheckout" : { "type" : "boolean", "description" : "A boolean indicating whether to store the payment method at checkout.", "example" : null }, "successUrl" : { "type" : "string", "description" : "A string that defines the URL to redirect to upon successful payment.", "example" : null }, "taxObjectIds" : { "type" : "array", "description" : "An array of string IDs representing tax objects associated with the payment link.", "example" : null, "items" : { "type" : "string", "example" : null } }, "taxes" : { "type" : "array", "description" : "An array of TaxRequest objects, each representing a tax associated with the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/TaxRequest" } } }, "example" : null }, "PaymentLinkFormField" : { "required" : [ "isRequired", "label", "objectType", "options", "propertyName" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A description of the form field, providing additional context or instructions, represented as a string.", "example" : null }, "isRequired" : { "type" : "boolean", "description" : "A boolean indicating whether this form field is required to be filled out.", "example" : null }, "label" : { "type" : "string", "description" : "The label for the form field, which is displayed to users, represented as a string.", "example" : null }, "objectType" : { "type" : "string", "description" : "The type of object this form field is associated with, represented as a string. Valid values include 'CONTACT' and 'COMPANY'.", "example" : null, "enum" : [ "COMPANY", "CONTACT" ] }, "options" : { "type" : "array", "description" : "An array of options available for this form field, each represented as a FormFieldOption object.", "example" : null, "items" : { "$ref" : "#/components/schemas/FormFieldOption" } }, "propertyName" : { "type" : "string", "description" : "The name of the property associated with this form field, represented as a string.", "example" : null } }, "example" : null }, "PaymentLinkResponse" : { "required" : [ "acceptedPaymentMethods", "additionalFormFields", "archived", "automatedSalesTaxEnabled", "checkoutFeeIds", "collectFullBillingAddress", "collectShippingAddress", "currencyCode", "discountCodeEnabled", "discounts", "fees", "formGuid", "id", "includeEmailInSuccessRedirect", "isOneTimeUseEnabled", "lineItems", "paymentLinkName", "paymentLinkUrl", "state", "storePaymentMethodAtCheckout", "taxes" ], "type" : "object", "properties" : { "acceptedPaymentMethods" : { "type" : "array", "description" : "An array of accepted payment methods for the payment link. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS" ] } }, "additionalFormFields" : { "type" : "array", "description" : "An array of additional form fields included in the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/PaymentLinkFormField" } }, "archived" : { "type" : "boolean", "description" : "A boolean indicating whether the payment link is archived.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The date and time when the payment link was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "automatedSalesTaxEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether automated sales tax is enabled for the payment link.", "example" : null }, "businessUnitId" : { "type" : "string", "description" : "The business unit ID associated with the payment link, represented as a string.", "example" : null }, "checkoutFeeIds" : { "type" : "array", "description" : "An array of checkout fee IDs associated with the payment link.", "example" : null, "items" : { "type" : "string", "example" : null } }, "collectFullBillingAddress" : { "type" : "boolean", "description" : "A boolean indicating whether to collect the full billing address during checkout.", "example" : null }, "collectShippingAddress" : { "type" : "boolean", "description" : "A boolean indicating whether to collect the shipping address during checkout.", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when the payment link was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "currencyCode" : { "type" : "string", "description" : "The currency code for the payment link, represented as a string.", "example" : null }, "dealConfigurations" : { "$ref" : "#/components/schemas/DealConfigurations" }, "descriptionHtml" : { "type" : "string", "description" : "The HTML description of the payment link, represented as a string.", "example" : null }, "discountCodeEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether discount codes are enabled for the payment link.", "example" : null }, "discounts" : { "type" : "array", "description" : "An array of discount objects associated with the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/DiscountResponse" } }, "domainId" : { "type" : "string", "description" : "The domain ID associated with the payment link, represented as a string.", "example" : null }, "fees" : { "type" : "array", "description" : "An array of fee objects associated with the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/FeeResponse" } }, "formGuid" : { "type" : "string", "description" : "The form GUID associated with the payment link, represented as a string.", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for the payment link, represented as a string.", "example" : null }, "includeEmailInSuccessRedirect" : { "type" : "boolean", "description" : "A boolean indicating whether to include the email in the success redirect URL.", "example" : null }, "isOneTimeUseEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether the payment link is enabled for one-time use.", "example" : null }, "lineItems" : { "type" : "array", "description" : "An array of line items associated with the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/LineItem" } }, "paymentLinkName" : { "type" : "string", "description" : "The name of the payment link, represented as a string.", "example" : null }, "paymentLinkUrl" : { "type" : "string", "description" : "The URL of the payment link, represented as a string.", "example" : null }, "state" : { "type" : "string", "description" : "The current state of the payment link, represented as a string. Valid values include 'ON' and 'OFF'.", "example" : null, "enum" : [ "OFF", "ON" ] }, "storePaymentMethodAtCheckout" : { "type" : "boolean", "description" : "A boolean indicating whether to store the payment method at checkout.", "example" : null }, "successUrl" : { "type" : "string", "description" : "The URL to redirect to upon successful payment, represented as a string.", "example" : null }, "taxes" : { "type" : "array", "description" : "An array of tax objects associated with the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/TaxResponse" } }, "updatedAt" : { "type" : "string", "description" : "The date and time when the payment link was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null } }, "example" : null }, "PaymentLinkUpdateRequest" : { "required" : [ "businessUnitId", "dealConfigurations", "descriptionHtml", "discountObjectId", "domainId", "successUrl" ], "type" : "object", "properties" : { "acceptedPaymentMethods" : { "type" : "array", "description" : "An array of strings indicating the accepted payment methods. Valid values include 'CREDIT_OR_DEBIT_CARD', 'ACH', 'SEPA', 'BACS', and 'PADS'.", "example" : null, "items" : { "type" : "string", "example" : null, "enum" : [ "CREDIT_OR_DEBIT_CARD", "ACH", "SEPA", "BACS", "PADS" ] } }, "additionalFormFields" : { "type" : "array", "description" : "An array of PaymentLinkFormField objects representing additional form fields for the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/PaymentLinkFormField" } }, "automatedSalesTaxEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether automated sales tax is enabled.", "example" : null }, "businessUnitId" : { "type" : "object", "properties" : { }, "description" : "An object representing the business unit ID associated with the payment link.", "example" : null }, "collectFullBillingAddress" : { "type" : "boolean", "description" : "A boolean indicating whether to collect the full billing address during checkout.", "example" : null }, "collectShippingAddress" : { "type" : "boolean", "description" : "A boolean indicating whether to collect the shipping address during checkout.", "example" : null }, "currencyCode" : { "type" : "string", "description" : "The currency code for the payment link, represented as a string.", "example" : null }, "dealConfigurations" : { "type" : "object", "properties" : { }, "description" : "An object containing deal configuration settings.", "example" : null }, "descriptionHtml" : { "type" : "object", "properties" : { }, "description" : "An object containing the HTML description of the payment link.", "example" : null }, "discount" : { "$ref" : "#/components/schemas/DiscountRequest" }, "discountCodeEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether discount codes are enabled for the payment link.", "example" : null }, "discountObjectId" : { "type" : "object", "properties" : { }, "description" : "An object representing the discount object ID associated with the payment link.", "example" : null }, "discountObjectIds" : { "type" : "array", "description" : "An array of strings representing the IDs of discount objects associated with the payment link.", "example" : null, "items" : { "type" : "string", "example" : null } }, "domainId" : { "type" : "object", "properties" : { }, "description" : "An object representing the domain ID associated with the payment link.", "example" : null }, "enableDefaultCheckoutFees" : { "type" : "boolean", "description" : "A boolean indicating whether default checkout fees are enabled.", "example" : null }, "feeObjectIds" : { "type" : "array", "description" : "An array of strings representing the IDs of fee objects associated with the payment link.", "example" : null, "items" : { "type" : "string", "example" : null } }, "fees" : { "type" : "array", "description" : "An array of FeeRequest objects representing the fees associated with the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/FeeRequest" } }, "includeEmailInSuccessRedirect" : { "type" : "boolean", "description" : "A boolean indicating whether to include the email in the success redirect.", "example" : null }, "isOneTimeUseEnabled" : { "type" : "boolean", "description" : "A boolean indicating whether the payment link is enabled for one-time use.", "example" : null }, "lineItemObjectIds" : { "type" : "array", "description" : "An array of strings representing the IDs of line item objects associated with the payment link.", "example" : null, "items" : { "type" : "string", "example" : null } }, "lineItems" : { "type" : "array", "description" : "An array of line item objects, which can be of types LineItemCustomCreateRequest, LineItemFromProductCreateRequest, or LineItemCloneCreateRequest.", "example" : null, "items" : { "example" : null, "oneOf" : [ { "$ref" : "#/components/schemas/LineItemCustomCreateRequest" }, { "$ref" : "#/components/schemas/LineItemFromProductCreateRequest" }, { "$ref" : "#/components/schemas/LineItemCloneCreateRequest" } ] } }, "paymentLinkName" : { "type" : "string", "description" : "The name of the payment link, represented as a string.", "example" : null }, "state" : { "type" : "string", "description" : "The state of the payment link, represented as a string. Valid values are 'ON' and 'OFF'.", "example" : null, "enum" : [ "OFF", "ON" ] }, "storePaymentMethodAtCheckout" : { "type" : "boolean", "description" : "A boolean indicating whether the payment method should be stored at checkout.", "example" : null }, "successUrl" : { "type" : "object", "properties" : { }, "description" : "An object representing the success URL where the user is redirected after a successful transaction.", "example" : null }, "taxObjectIds" : { "type" : "array", "description" : "An array of strings representing the IDs of tax objects associated with the payment link.", "example" : null, "items" : { "type" : "string", "example" : null } }, "taxes" : { "type" : "array", "description" : "An array of TaxRequest objects representing the taxes associated with the payment link.", "example" : null, "items" : { "$ref" : "#/components/schemas/TaxRequest" } } }, "example" : null }, "PriceEntry" : { "required" : [ "currencyCode", "price" ], "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The currency code for the price, represented as a string.", "example" : null }, "maxQuantity" : { "type" : "string", "description" : "The maximum quantity for which this price is applicable, represented as a string.", "example" : null }, "price" : { "type" : "number", "description" : "The price of the item, represented as a number.", "example" : null } }, "example" : null }, "PriceUpdateEntry" : { "required" : [ "currencyCode", "price" ], "type" : "object", "properties" : { "currencyCode" : { "type" : "string", "description" : "The currency code in which the price is specified, represented as a string.", "example" : null }, "maxQuantity" : { "type" : "string", "description" : "The maximum quantity for which this price is applicable, represented as a string.", "example" : null }, "price" : { "type" : "object", "properties" : { }, "description" : "An object representing the price details. The specific structure of this object is not detailed in the specification.", "example" : null } }, "example" : null }, "Pricing" : { "required" : [ "prices", "pricingModel" ], "type" : "object", "properties" : { "prices" : { "type" : "array", "description" : "An array of price entries, each detailing a specific price point within the pricing model.", "example" : null, "items" : { "$ref" : "#/components/schemas/PriceEntry" } }, "pricingModel" : { "type" : "string", "description" : "The type of pricing model applied. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.", "example" : null, "enum" : [ "FLAT", "GRADUATED", "STAIRSTEP", "VOLUME" ] } }, "example" : null }, "PricingFullUpdateRequest" : { "required" : [ "prices", "pricingModel" ], "type" : "object", "properties" : { "prices" : { "type" : "array", "description" : "An array of PriceUpdateEntry objects, each specifying the price details such as currency code and price amount for different quantities.", "example" : null, "items" : { "$ref" : "#/components/schemas/PriceUpdateEntry" } }, "pricingModel" : { "type" : "string", "description" : "The pricing model applied to the line item. Valid values include 'FLAT', 'GRADUATED', 'STAIRSTEP', and 'VOLUME'.", "example" : null, "enum" : [ "FLAT", "GRADUATED", "STAIRSTEP", "VOLUME" ] } }, "example" : null }, "TaxRequest" : { "required" : [ "label", "value", "valueType" ], "type" : "object", "properties" : { "label" : { "type" : "string", "description" : "A string that provides a label or description for the tax, used for identification or display purposes.", "example" : null }, "value" : { "type" : "number", "description" : "The numeric value of the tax. It represents the amount or percentage, depending on the valueType.", "example" : null }, "valueType" : { "type" : "string", "description" : "A string indicating the type of tax value. Valid values are 'FIXED' for a fixed amount and 'PERCENT' for a percentage-based tax.", "example" : null, "enum" : [ "FIXED", "PERCENT" ] } }, "example" : null }, "TaxResponse" : { "required" : [ "id" ], "type" : "object", "properties" : { "archived" : { "type" : "boolean", "description" : "Indicates whether this tax entry is archived. A boolean value.", "example" : null }, "archivedAt" : { "type" : "string", "description" : "The date and time when this tax entry was archived, in ISO 8601 format.", "format" : "date-time", "example" : null }, "createdAt" : { "type" : "string", "description" : "The date and time when this tax entry was created, in ISO 8601 format.", "format" : "date-time", "example" : null }, "id" : { "type" : "string", "description" : "The unique identifier for this tax entry.", "example" : null }, "label" : { "type" : "string", "description" : "A descriptive label for this tax entry.", "example" : null }, "updatedAt" : { "type" : "string", "description" : "The date and time when this tax entry was last updated, in ISO 8601 format.", "format" : "date-time", "example" : null }, "value" : { "type" : "number", "description" : "The numerical value of the tax.", "example" : null }, "valueType" : { "type" : "string", "description" : "The type of value for the tax, which can be either 'FIXED' or 'PERCENT'.", "example" : null, "enum" : [ "FIXED", "PERCENT" ] } }, "example" : null } }, "responses" : { "Error" : { "description" : "An error occurred.", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Error" }, "example" : null } } } }, "securitySchemes" : { "developer_hapikey" : { "type" : "apiKey", "name" : "hapikey", "in" : "query" }, "oauth2" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://app.hubspot.com/oauth/authorize", "tokenUrl" : "https://api.hubapi.com/oauth/v1/token", "scopes" : { "payment-links-delete" : "", "payment-links-read" : "", "payment-links-write" : "" } } } }, "private_apps" : { "type" : "apiKey", "name" : "private-app", "in" : "header" }, "private_apps_legacy" : { "type" : "apiKey", "name" : "private-app-legacy", "in" : "header" } } }, "x-hubspot-product-tier-requirements" : { "marketing" : "FREE", "sales" : "FREE", "service" : "FREE", "cms" : "FREE", "commerce" : "FREE", "crmHub" : "FREE", "dataHub" : "FREE" } }