SoraiDocs
GuidesAPI reference

sorai checkout create

Open a checkout link for one price of an active product, to send to a buyer.

The link's url is returned only once, so keep it. Paying through it runs the normal fulfilment: files, license keys and library access.

sorai checkout create --price-id <uuid> [flags]

Flags

  • --store <id|slug>: A store id or slug. Defaults to SORAI_STORE, the saved login's store, or the only store.
  • --price-id <uuid> (required): A price of one of this store's active products, from sorai prices list.
  • --quantity <int>: Defaults to 1.
  • --buyer-email <email>: Prefills the buyer's email. The buyer can still change it.
  • --metadata <json>: Up to 20 string values, returned on the order's webhooks. Keys use letters, digits, _, . and - (40 at most).
  • --expires-in-seconds <int>: How long the link stays open. Defaults to 86400 (one day).
  • --allow-discount-codes: Let the buyer apply a discount code. Off by default.
  • --dry-run: Print the request it would send, and for an update the fields that would change, without changing anything.

Permissions

Needs a key with the checkout:write permission.

This command changes data. Run it with --dry-run first to see what it would do.

On this page