Create invoice
Creates a new checkout invoice for the authenticated store. Returns a legacy error shape on some validation failures for backward compatibility.
Authorizations
Store-scoped API key. Prefix with sk_live_.
Example: Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE
Body
Required. Your own order or reference number (e.g. "order_1048").
Sent back in webhooks so you can match payments to orders in your system.
"order_demo_1048"
Required. How much you want to receive, as a decimal string (e.g. "100.00").
This is the amount after currency conversion, in the currency below.
"100.00"
Which store this invoice belongs to. Optional: uses your API key's default store if omitted. Must match the store tied to your API key when provided.
Optional. Link this invoice to a connected platform (e.g. WooCommerce). Omit unless you received this ID from a platform integration.
Optional. Three-letter currency code for amount (e.g. USD, EUR).
Defaults to USD if omitted.
"USD"
Optional. Legacy server callback URL. For new integrations, use Webhooks instead. Omit if you rely on webhooks.
Optional. Where to send the customer after they finish or cancel checkout. Omit if you handle completion via webhooks only.
Optional. Custom data attached to the invoice (e.g. {"cart_id": "abc"}).
Returned in webhooks. Omit if you don't need extra fields.
Response
Invoice created
Unique invoice ID starting with inv_. Save this to check status or handle webhooks.
^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$Where the invoice is in the payment flow:
pending: created, not yet ready for paymentquoted: price quote ready; customer can proceed to payawaiting_payment: waiting for the customer to send fundspaid: payment received and confirmedunderpaid: customer paid less than the requested amountexpired: not paid before the deadlinefailed: payment or processing failedrefunded: payment was returned to the customercancelled: invoice was cancelled before completion
pending, quoted, awaiting_payment, paid, underpaid, expired, failed, refunded, cancelled Send your customer to this URL to pay (e.g. https://pay.meum.io/...).
Open in a browser or redirect from your site.
"https://pay.meum.io/550e8400-e29b-41d4-a716-446655440000"
Same as checkout_url. Kept for older integrations; prefer checkout_url.
Invoice amount as a decimal string (e.g. "100.00").
"100.00"
Currency code for amount (e.g. USD).
"USD"
Stablecoin you receive when paid (e.g. USDC).
"USDC"
When this invoice stops accepting payment if still unpaid (UTC, e.g. 2025-09-01T14:31:44.171Z).