List checkout links
Returns every hosted-checkout link of the organization (unpaginated).
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List checkout links › Responses
OK
Create a checkout link
Creates a hosted-checkout link for a plan. Customer/subscription defaults are optional - null means "inherit".
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Create a checkout link › Request Body
collect_addresscollect_phonecollect_vat_idcurrencydefault_billing_timingdefault_payment_terms_daysdefault_preferred_providerdefault_wallet_modemetadatanameplan_idslugsuccess_urltax_inclusivetrial_daysvat_id_collectionCreate a checkout link › Responses
Created
Get a checkout link
path Parameters
idCheckout link UUID
Checkout link UUID
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get a checkout link › Responses
OK
Update a checkout link
Updates a checkout link. Nullable text defaults follow the empty-string-sentinel convention: omit to leave unchanged, send "" to clear back to "inherit".
path Parameters
idCheckout link UUID
Checkout link UUID
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Update a checkout link › Request Body
collect_addresscollect_phonecollect_vat_idcurrencydefault_billing_timingdefault_payment_terms_daysdefault_preferred_providerdefault_wallet_modemetadatanamestatussuccess_urltax_inclusivetrial_daysvat_id_collectionUpdate a checkout link › Responses
OK
Delete a checkout link
path Parameters
idCheckout link UUID
Checkout link UUID
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Delete a checkout link › Responses
No Content