Schemas

Amount to collect, in whole XAF. Minimum 100.

Customer's phone number in international format. The prompt is sent to this handset.

How the customer pays. mobile_money is MTN Mobile Money, orange_money is Orange Money. More instruments will be added here rather than in a second field.

Field label shown to the payer

Whether the field is mandatory

Field type (e.g. text, email, number)

Help text shown under the field

Stable field key (defaults to a slug of the label)

Variant name

Variant price in whole XAF

Linked inventory item id

Stock keeping unit

Variant image URL

Display order

Whether this is the default variant

Whether the variant is selectable

Minimum quantity for this tier

Unit price in whole XAF for this tier

Maximum quantity for this tier (omit for open-ended)

Display order

Name shown on the checkout page

Amount to collect, in whole XAF. Minimum 100.

Description shown to the payer

Currency (defaults to XAF)

Allow the link to be paid more than once

Cap the number of payments allowed

HTTPS URL the payer is redirected to after success

HTTPS URL the payer is redirected to after failure

Expiry timestamp (ISO 8601)

Extra fields the payer must complete

Cover image URL

Additional image URLs

Link type: STANDARD, INVENTORY_ITEM or DONATION

Inventory item id (when type is INVENTORY_ITEM)

Let the payer choose the amount

Minimum amount when allow_custom_amount is true. Cannot go below 100.

Maximum amount when allow_custom_amount is true

Allow the payer to choose a quantity

Whether the link has variants

Whether the link has tiered pricing

Custom URL slug (must be unique)

Organizational tags

Product variants

Quantity-based pricing tiers

Link title

Link description

Amount in whole XAF. Minimum 100.

Cover image URL

Additional image URLs

Allow the link to be paid more than once

Maximum number of payments

Redirect URL after a successful payment

Redirect URL after a failed payment

Expiry timestamp (ISO 8601)

Link status

What the file will be used for. Determines size and type limits.

Original file name, used only for its extension

MIME type. Must match the Content-Type you PUT, or the signature is invalid.

Exact byte length. Signed into the URL, so storage rejects a body of any other size — this is what enforces the cap once the bytes no longer pass through us.

Seconds the upload URL stays valid. Defaults to 300.

Line item name

Unit price in whole XAF

Quantity

Free-text note for this line

Customer's name, shown on the invoice

Due date (ISO 8601)

Line items. At least one.

Customer email. Required to send the invoice by email.

Customer phone in international format

Invoice-level discount as a PERCENTAGE of the subtotal, 0–100. 10 means 10% off, not 10 XAF.

Notes shown on the invoice

Currency. XAF only today; present so the field is stable when others land.

Cover image URL from POST /v1/files/upload-url. Must be on our storage host.

Your own identifier for this invoice, echoed back on reads.

Delivery channel. Defaults to EMAIL.

Send to this address instead of the invoice's customer_email.

Send to this number instead of the invoice's customer_phone.