Link data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_activebooleanNo
lineitemsPaymentLineitem[]No
lineitems[].idstringNo
lineitems[].created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].refunded_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].total_amountnumberNo
lineitems[].refund_amountnumberNonew field
lineitems[].discount_amountnumberNo
lineitems[].tax_amountnumberNo
lineitems[].item_idstringNo(reference to CommerceItem)
lineitems[].unit_amountnumberNo
lineitems[].unit_quantitynumberNo
lineitems[].item_skustringNo
lineitems[].item_namestringNo
lineitems[].item_descriptionstringNo
lineitems[].notesstringNo
lineitems[].taxrate_idstringNo
lineitems[].account_idstringNo(reference to AccountingAccount)
currencystringNo
amountnumberNo
payment_idstringNo(reference to PaymentPayment)
contact_idstringNoID of the AccountingContact (reference to AccountingContact)
urlstringNothe payment link
descriptionstringNo
is_chargeable_nowbooleanNo
success_urlstringNo

TypeScript

TypeScript
export type PaymentLink = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	is_active?: boolean;
	lineitems?: [];
	currency?: string;
	amount?: number;
	payment_id?: string; // (reference to PaymentPayment)
	contact_id?: string; // ID of the AccountingContact (reference to AccountingContact)
	url?: string; // the payment link
	description?: string;
	is_chargeable_now?: boolean;
	success_url?: string;
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodPaymentLink = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	is_active: z.boolean().optional(),
	lineitems: z.array().optional(),
	currency: z.string().optional(),
	amount: z.number().optional(),
	payment_id: z.string().optional().describe("(reference to PaymentPayment)"),
	contact_id: z.string().optional().describe("ID of the AccountingContact (reference to AccountingContact)"),
	url: z.string().optional().describe("the payment link"),
	description: z.string().optional(),
	is_chargeable_now: z.boolean().optional(),
	success_url: z.string().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PaymentLink:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	is_active: Optional[bool]
	lineitems: Optional[PropertyPaymentLinkLineitems]
	currency: Optional[str]
	amount: Optional[int]
	"""(reference to PaymentPayment)"""
	payment_id: Optional[str]
	"""ID of the AccountingContact (reference to AccountingContact)"""
	contact_id: Optional[str]
	"""the payment link"""
	url: Optional[str]
	description: Optional[str]
	is_chargeable_now: Optional[bool]
	success_url: Optional[str]
Are we missing anything? Let us know
Was this page helpful?