1. Docs
2. /
3. Tool reference
4. /
5. Commerce
6. /
7. createPaymentLink

Commerce

createPaymentLink

Create Payment Link

Create one Cloud-hosted payment link with library products, manual lines, an optional deposit, and an email, phone, or saved client.

write

Arguments

• currencystringoptionalNo description is declared in the tool schema.
• customerobjectrequiredNo description is declared in the tool schema.
• depositobjectoptionalNo description is declared in the tool schema.
• dueDatestringoptionalNo description is declared in the tool schema.
• entryIdstringoptionalNo description is declared in the tool schema.
• linesobject[]requiredNo description is declared in the tool schema.
• locationIdstringrequiredNo description is declared in the tool schema.
• memostringoptionalNo description is declared in the tool schema.
• orderIdstringoptionalNo description is declared in the tool schema.
• spaceIdstringoptionalNo description is declared in the tool schema.
• titlestringrequiredNo description is declared in the tool schema.

Returns

The registry does not declare a return shape.

Declared limits

• currency: minimum length 3
• currency: maximum length 3
• lines: minimum items 1
• lines: maximum items 50
• title: minimum length 1

Ask for it

The Cloud routes these requests to this verb.

• create a payment link
• request a deposit
• make a balance link

Pair it with

The verbs that finish the job.

• listProducts
• sendPaymentLink
• attachPaymentLinkToEntry