Start a tree sponsorship
start_sponsorshipNeeds OAuth scope sponsor:write (a Shared Forest account). Creates an unpaid order for the signed-in user and holds the spots. It charges nothing. The total must fit the spending limit the user set when connecting. The order expires after 30 minutes unless the user confirms. Returns confirm_url: give it to your user. The user logs in, accepts the terms and pays on that page. Ask the user before you call it and confirm name and total.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| link | No | Optional https link. It goes live after manual review. | |
| No | Optional email for the confirmation and the invoice. Default: the email of the signed-in account. | ||
| spots | No | Optional positions from find_spots, one per tree. Omit and the server picks free spots. | |
| quantity | Yes | Number of trees, 1-100. Larger orders get a lower unit price. | |
| design_ids | Yes | One design_id for all trees, or one per tree. | |
| display_name | Yes | Name shown on the trees, 1-32 characters, labelled Sponsored. | |
| idempotency_key | Yes | Retry key, for example a UUID. A retry with the same key returns the same order. |