Checkout Sales Order

Beta

POST/v1/sales/sales-orders/{id}/checkout

Idempotent with Idempotency-Key header. Learn more

Creates a hosted payment checkout session for a sales order.

Requires an active Stripe integration on the account. The checkout is built from the order's lines, and the checkout link is emailed to the provided address. Fails with a conflict if the order already has a payment.

Permissions requiredValues:sales_orders:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Sales order ID.

emailstring

Email address to send the checkout link to.

Also set as the customer email on the payment provider's checkout session.

objectstringenumValues:checkout_sales_order

Resource type identifier.

checkout_urlstring

URL of the hosted payment page where the customer completes the checkout.

Responses

200

Successful response for Checkout Sales Order

Checkout Sales Order

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const checkoutSalesOrderResponse = await client.sales.salesOrders.checkout(
  'or_01d5034136c3ccc048abecc312',
  { email: 'operations@acme.example.com' },
);

console.log(checkoutSalesOrderResponse.checkout_url);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const checkoutSalesOrderResponse = await client.sales.salesOrders.checkout(
  'or_01d5034136c3ccc048abecc312',
  { email: 'operations@acme.example.com' },
);

console.log(checkoutSalesOrderResponse.checkout_url);

200 example

{
  "object": "checkout_sales_order",
  "checkout_url": "https://checkout.stripe.com/pay/cs_test_example"
}

{
  "object": "checkout_sales_order",
  "checkout_url": "https://checkout.stripe.com/pay/cs_test_example"
}

Checkout Sales Order

Authorization

Path Parameters

Request Body

Returns

Responses