v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Billing

Create coupon

post/coupons/

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Request body

idstring
namestring required
amountnumber required
currencystring required
discount_scheme'%' | '$'
duration_scheme'one_time' | 'forever' | 'limited'
duration_timesinteger nullable

Required when duration_scheme=limited. Number of billing cycles.

valid_untilstring date nullable
apply_on'line' | 'invoice'
status'active' | 'archived'
archivedstring date-time nullable
createdstring date-time
updatedstring date-time

Response

Coupon created.

idstring
namestring required
amountnumber required
currencystring required
discount_scheme'%' | '$'
duration_scheme'one_time' | 'forever' | 'limited'
duration_timesinteger nullable

Required when duration_scheme=limited. Number of billing cycles.

valid_untilstring date nullable
apply_on'line' | 'invoice'
status'active' | 'archived'
archivedstring date-time nullable
createdstring date-time
updatedstring date-time